Repository navigation
Revise docs to reflect we are targeting drones beyond crazyflies - #154
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues remain for the documentation update describing broader quadrotor support.
No open issues 🎉
What changed in this PR
Updates Crazyflow’s documentation to describe support for quadrotors beyond Crazyflies, addressing #150 and highlighting the Holybro X500 alongside existing platforms.
Changes:
- Broadens project descriptions and user guidance from Crazyflie-specific wording to quadrotors.
- Adds a supported-drone table and refreshes configuration examples.
- Adds a unit test checking that the README lists exactly the supported
Dronemembers.
| File | Description |
|---|---|
tests/unit/test_readme.py |
Checks README drone entries against the Drone enum. |
README.md |
Broadens the introduction and lists supported platforms. |
properdocs.yml |
Updates the documentation site description. |
docs/user-guide/dynamics/symbolic.md |
Generalizes guidance on pre-fitted platform parameters. |
docs/user-guide/dynamics/parametrize.md |
Refreshes drone and dynamics availability examples. |
docs/user-guide/dynamics/index.md |
Removes a Crazyflie-specific controller reference. |
docs/index.md |
Broadens the overview and names Holybro X500 support. |
docs/get-started/quick-start.md |
Includes drone platform among simulator configuration options. |
Review effort: Balanced
ratheron
approved these changes
Nov 6, 2026
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.
Closes #150