Restructure docs and enhance sidebar navigation#4
Open
oerjanberger wants to merge 3 commits intomainfrom
Hidden character warning
The head ref may contain hidden characters: "\u00f8rjan/implement-data-from-existing-user-manuals"
Open
Conversation
Archived legacy ConnectPOB documentation and images, moving them to an Archived directory. Added new introduction and overview documentation for ConnectCCM, ConnectFuel, and ConnectData, including API and FAQ sections. Significantly expanded and reorganized the sidebar in .vitepress/config.mts to reflect new documentation structure and improve navigation. Updated theme CSS for navigation buttons, details elements, and FAQ cards. Updated README with guidelines for adding FAQ entries.
Reorganized FAQ files into a more granular structure, renaming and moving them into a 'faqs' subdirectory. Updated the VitePress sidebar configuration to reflect the new FAQ organization and added detailed navigation items. Added a comprehensive OWC installation manual to the installation guide.
oerjanberger
added
documentation
There was a problem hiding this comment.
Pull Request Overview
This pull request implements a comprehensive documentation restructuring with enhanced navigation and new content. The changes focus on archiving legacy documentation, introducing new product-specific content, and significantly improving user experience through better organization and styling.
- Archived legacy ConnectPOB documentation and images to maintain historical content while clearing space for new structure
- Added comprehensive introduction and overview documentation for ConnectCCM, ConnectFuel, and ConnectData with user-focused content
- Significantly expanded sidebar navigation with hierarchical organization and new FAQ system with categorized content
Reviewed Changes
Copilot reviewed 35 out of 115 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| docs/images/release-images/generic-dashboard-icon.svg | Added new SVG icon for generic dashboard functionality |
| docs/Release-notes/release-notes.md | Created comprehensive release notes with detailed version history and feature descriptions |
| docs/OWC/introduction.md | Enhanced OWC introduction with mission statement and foundational system overview |
| docs/OWC/Installation/installation-overview.md | Added detailed installation overview covering components, process, and safety considerations |
| docs/OWC/Installation/installation-guide.md | Created comprehensive installation manual with step-by-step procedures and troubleshooting |
| docs/Faq/faqs/*.md | Added categorized FAQ system covering system administration, support, operations, hardware, and data monitoring |
| docs/Faq/faq-introduction.md | Created FAQ introduction page with category navigation and support contact information |
| docs/ConnectPOB/pages/*.md | Added detailed page documentation for all ConnectPOB interface pages with functionality descriptions |
| docs/ConnectPOB/introduction/*.md | Created comprehensive ConnectPOB introduction materials including user guides and system overview |
| docs/ConnectFuel/Introduction/*.md | Added complete ConnectFuel introduction documentation with user roles and operational integration |
| docs/ConnectCCM/Introduction/*.md | Created ConnectCCM introduction materials covering environmental monitoring and user responsibilities |
| README.md | Updated with guidelines for adding FAQ entries and content management procedures |
| .vitepress/theme/style.css | Enhanced CSS with navigation button styling, details element theming, and FAQ card layouts |
| .vitepress/config.mts | Significantly expanded sidebar configuration with hierarchical navigation and new content organization |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
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
1 participant
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.
Archived legacy ConnectPOB documentation and images, moving them to an Archived directory. Added new introduction and overview documentation for ConnectCCM, ConnectFuel, and ConnectData, including API and FAQ sections. Significantly expanded and reorganized the sidebar in .vitepress/config.mts to reflect new documentation structure and improve navigation. Updated theme CSS for navigation buttons, details elements, and FAQ cards. Updated README with guidelines for adding FAQ entries.