docs(ota_demo): add architecture diagram to README#71
Open
bburda wants to merge 1 commit into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Adds an Architecture section to the ota_nav2_sensor_fix demo README to give readers a high-level “one glance” system map, backed by a new SVG diagram committed under docs/.
Changes:
- Add an “Architecture” section describing the off-board/on-board split and key flows.
- Embed a new architecture SVG diagram into the README via a relative path.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| demos/ota_nav2_sensor_fix/README.md | Adds an Architecture section and embeds the diagram. |
| demos/ota_nav2_sensor_fix/docs/architecture.svg | Introduces the SVG architecture diagram asset. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
bburda
force-pushed
the
docs/ota-demo-architecture-svg
branch
from
July 15, 2026 15:28
a66dca3 to
336f859
Compare
Add an Architecture section with a high-level SVG diagram of the ota_nav2_sensor_fix demo (off-board tooling, on-board ros2_medkit stack + robot, and the OTA / fault-detection flows). Also drop the retired "Studio" from the Foxglove name across the demo (README, run-demo.sh, demo.launch.py, and the diagram).
bburda
force-pushed
the
docs/ota-demo-architecture-svg
branch
from
July 15, 2026 15:30
336f859 to
a2dd367
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.
Description
Add an Architecture section to the
ota_nav2_sensor_fixdemo README with a high-level SVG diagram, giving readers a one-glance map before the step-by-step narrative.The diagram splits the system into off-board (update backend + the Foxglove UI with the
ros2_medkitSOVD extension) and on-board (theros2_medkitstack + the robot's ROS 2 app), and colour-codes the flows: OTA / SOVD, node hot-swap, fault detection, and Foxglove telemetry. Components are keyed by origin (ros2_medkit product / demo-only / Foxglove / Nav2).Docs-only change. The SVG is committed under
docs/and embedded via a relative path.Related Issue
closes #
Checklist