Roscopter user guide - #41
Merged
Merged
Conversation
JMoore5353
requested review from
Copilot,
gabesnow99,
iandareid and
jritchie21
December 1, 2025 16:44
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive ROScopter documentation to the User Guide section, restructuring the documentation to match the intended future organization. The changes replace a placeholder setup file with detailed architecture and customization guides, while also adding navigation structure for a new ROScopter developer guide section.
Key Changes:
- Adds detailed ROScopter architecture documentation (~648 lines)
- Adds customization guide for extending ROScopter (~100 lines)
- Adds ROScopter overview with quick start guide (~54 lines)
- Replaces placeholder roscopter-setup.md file
- Fixes spelling error in rosplane-overview.md
- Adds state machine diagram (SVG)
Reviewed changes
Copilot reviewed 8 out of 11 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Updates navigation to replace setup page with architecture and customization pages; adds developer guide section |
| rosplane-overview.md | Fixes spelling: "build" → "built" |
| roscopter-setup.md | Deleted placeholder file |
| roscopter-overview.md | New overview page with quick start guide and core functionality description |
| roscopter-architecture.md | New comprehensive architecture guide detailing all ROScopter modules |
| customizing-roscopter.md | New guide explaining ROScopter's modular design and customization patterns |
| autonomous-flight.md | Updates link from roscopter-setup.md to roscopter-overview.md |
| roscopter-dev-overview.md | New placeholder for developer guide (under development) |
| roscopter_state_machine.svg | New state machine diagram image |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
JMoore5353
force-pushed
the
roscopter-user-guide
branch
from
December 9, 2025 20:14
2823e48 to
14f0253
Compare
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
JMoore5353
force-pushed
the
roscopter-user-guide
branch
from
December 9, 2025 21:48
14f0253 to
d88b738
Compare
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
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.
This PR adds ROScopter documentation to the User Guide section of the website.
This user guide is structured a little differently than previous documentation. In future PRs/branches, we should restructure ROSplane and Dev Guide (and rework the ROScopter User Guide) to all match and put information in common locations. For now, this documentation is ready to be merged in.