-
Notifications
You must be signed in to change notification settings - Fork 1
Restructure dev and user guides #52
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR restructures the documentation by reorganizing files for better navigation and reducing clutter. The main changes involve moving files between directories, creating index pages that load when users click navigation headings, and updating all internal hyperlinks to reflect the new structure.
Key changes:
- Enabled
navigation.indexesfeature in mkdocs to support index pages for navigation sections - Moved ROSflight firmware documentation from developer-guide to user-guide
- Created index.md files for Tutorials, ROSplane, and ROScopter sections to replace overview pages
- Reorganized "Hardware and ROSflight" section by moving files from concepts/ to hardware-and-rosflight/
- Removed ROScopter developer guide files from the navigation
- Updated all internal documentation links to reflect new file locations
Reviewed changes
Copilot reviewed 26 out of 41 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updated navigation structure, enabled navigation.indexes, reorganized sections |
| docs/user-guide/tutorials/*.md | Updated internal links to reflect moved hardware-and-rosflight files |
| docs/user-guide/tutorials/index.md | New index page for tutorials section |
| docs/user-guide/rosplane/*.md | Updated links to index.md and moved files |
| docs/user-guide/rosplane/index.md | New index page for ROSplane section |
| docs/user-guide/rosflight-sim/*.md | Updated links to hardware-and-rosflight directory |
| docs/user-guide/rosflight-firmware/*.md | Updated image paths after move from developer-guide |
| docs/user-guide/roscopter/index.md | New index page for ROScopter section |
| docs/user-guide/overview.md | Updated links to new index.md files |
| docs/user-guide/installation/*.md | Updated links to hardware-and-rosflight directory |
| docs/user-guide/images/*.{png,svg} | New image files added to user-guide |
| docs/user-guide/hardware-and-rosflight/*.md | New files for RC and preflight configuration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…osflight-firmware section
|
I also moved a lot of the files from the "Hardware and ROSflight" section to the rosflight-firmware section, since it seemed like they made more sense there. @iandareid Please let me know if you think anything needs to be reverted or changed. I think this made the documentation structure more clear, but it could still improve. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 30 out of 46 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This PR moves files around for more consistent/intuitive organization (I believe). Some key changes:
I did not yet move the rosplane-dev-guide to the user-guide, though @iandareid and I determined that it should be moved, so that I didn't mess up @iandareid current branch worse :)
Closes #8