Consolidate Documentation Sources into GitHub Pages Site#72
Open
justingeeslin wants to merge 1 commit intomasterfrom
Open
Consolidate Documentation Sources into GitHub Pages Site#72justingeeslin wants to merge 1 commit intomasterfrom
justingeeslin wants to merge 1 commit intomasterfrom
Conversation
- Add comprehensive User Guide page linking to PDFs and tutorials - Create Developer Documentation section with coding conventions and setup guides - Copy User Guide and Tutorial PDFs from external documentation repository - Add navigation menu items for User Guide and Developer sections - Update home page to highlight consolidated documentation resources - Update README to reflect documentation consolidation - Improve building guide with platform-specific instructions Addresses issue #2 by consolidating scattered documentation sources: - External documentation repository content - PDF user guides and tutorials - Developer setup and coding conventions - Better organization and cross-linking All documentation is now centralized in the GitHub Pages site for easier maintenance and improved user experience.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses Issue #2 by consolidating scattered CogTool documentation sources into a unified GitHub Pages site.
Changes Made
Documentation Structure
Files Added
docs/user-guide.md- Comprehensive user guide with links to all resourcesdocs/developer.md- Developer documentation hubdocs/developer/configuring-development-machines.md- Development setup guidedocs/developer/coding-conventions.md- Code style and conventionsdocs/downloads/CogToolUserGuide_1_2.pdf- User guide PDFdocs/downloads/CogToolTutorial.pdf- Tutorial PDFFiles Updated
docs/building.md- Enhanced with comprehensive build instructionsdocs/_layouts/default.html- Updated navigation menudocs/index.md- Added documentation section highlighting consolidated resourcesREADME.md- Updated to reflect consolidated documentationSources Consolidated
Benefits
Testing
Future Work
Fixes #2