Elaborate full autonomy documentation #2548
Merged
Merged
Conversation
…-docs merge main
github-actions
Bot
added
the
documentation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates and expands the documentation for OM1 full autonomy and related release notes, including adding new Hybrid Localisation documentation and restructuring several full autonomy guideline pages for readability and consistency.
Changes:
- Added new Hybrid Localisation documentation and linked it from the docs summary.
- Reworked multiple Full Autonomy Guidelines pages (architecture overview, lifecycle, modes, mode selection, BrainPack intro) with improved structure and formatting.
- Updated release notes across OM1 components (including adding a new OM1-OTA release-notes section and expanding OM1 v1.0.x notes).
Reviewed changes
Copilot reviewed 16 out of 19 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/release-notes/om1-video-processor/v1.0.x.md | Adjusts release-note version headings/formatting. |
| docs/release-notes/om1-video-processor/docker_images.md | Simplifies Docker image setup text. |
| docs/release-notes/om1-video-processor/beta.md | Adjusts beta release-note version headings/formatting. |
| docs/release-notes/om1-ros2-sdk/v1.0.x.md | Adjusts release-note version headings/formatting. |
| docs/release-notes/om1-ros2-sdk/docker_images.md | Simplifies Docker image setup text. |
| docs/release-notes/om1-ros2-sdk/beta.md | Adjusts beta release-note version headings/formatting. |
| docs/release-notes/om/v1.0.x.md | Adds v1.0.2-beta.1 notes and marks it latest. |
| docs/release-notes/major-updates/production_ready_release.md | Updates core services list to include OM1-OTA. |
| docs/release-notes/OM1-OTA/v1.0.x.md | Adds production release notes for the OTA/system-setup component. |
| docs/release-notes/OM1-OTA/docker_images.md | Adds Docker image instructions for OTA/system-setup. |
| docs/release-notes/OM1-OTA/beta.md | Adds beta release notes for OTA/system-setup. |
| docs/full_autonomy_guidelines/system_config.md | Fixes/clarifies code block boundaries around systemd service instructions. |
| docs/full_autonomy_guidelines/modes.md | Improves headings/structure and links lifecycle doc. |
| docs/full_autonomy_guidelines/mode_selection.md | Refactors voice/manual trigger instructions into clearer steps and a table. |
| docs/full_autonomy_guidelines/localisation.md | Adds new Hybrid Localisation deep-dive documentation. |
| docs/full_autonomy_guidelines/lifecycle.md | Restructures lifecycle doc into an overview + conceptual model table. |
| docs/full_autonomy_guidelines/brainpack_introduction.md | Expands BrainPack content with feature/spec/support tables. |
| docs/full_autonomy_guidelines/architecture_overview.md | Major rewrite: clarifies open-source vs premium components and expands component descriptions. |
| docs/SUMMARY.md | Adds Hybrid Localisation to navigation. |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Prachi1615
changed the title
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.
Overview
This PR significantly enhances the Full Autonomy Guidelines documentation.
Changes made: