Repository navigation
docs: rework the README around a 3-step quick start - #709
Merged
Merged
Conversation
Make the README quick to scan for engineers and get ros2_medkit running before anything else. - Top: the selfpatch.ai logo, a compact header and the existing badges, unchanged. - A one-paragraph description in plain language. - Quick start in three steps: get Docker, run the existing docker command (unchanged), then list every node ros2_medkit found and the faults. A tip confirms setup is done, and a pointer to the sensor demo shows a fault appearing when there is no robot to hand. - Extras in accordions: what a fault looks like, the live stream and web UI, installing without Docker, troubleshooting. - Standard sections: How it works, Features, Compared with standard ROS 2 diagnostics, Ecosystem, Documentation, Contributing, License. The logo, header and how-it-works diagram live in selfpatch/.github (profile/design/ros2_medkit.html) and load from raw.githubusercontent.com, so this repository carries no image binaries for the README. Drop the 15 MB docs/_static/images/medkit_hero.gif, which nothing references any more.
loehub
force-pushed
the
docs/readme-brand-redesign
branch
from
October 5, 2026 17:27
bd26de7 to
10663cd
Compare
bburda
approved these changes
Oct 5, 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.
Pull Request
Summary
Reworks the README so an engineer can scan it the way GitHub READMEs are usually read, and get ros2_medkit running first.
main, unchanged (CI, codecov, docs, license, ROS 2 distros, Discord).docker runcommand (unchanged), thencurl /api/v1/appsto see every node it found, which is never empty on a running robot, and/api/v1/faults. A green tip confirms you're done.selfpatch_demos, where./inject-nan.shmakes a fault appear.Removed: the Medkit Pro panel, the marketing copy, the image panels and the demo GIF. Copy is in plain language, and no other products are named.
Images: the logo, header and diagram live in selfpatch/.github (merged in selfpatch/.github#4) and load from
raw.githubusercontent.com, so this repository carries no image binaries for the README. This PR also removes the unused 15 MBdocs/_static/images/medkit_hero.gif.Issue
No linked issue. This is a docs-only rework requested by the team; no issue tracks it.
Type
Testing
raw.githubusercontent.com/selfpatch/.github/main/profile/assets/ros2_medkit/return 200 now that Host the ros2_medkit README images next to the profile .github#4 is merged.bringup.launch.pybinds127.0.0.1by default, so the remote-access tip addsserver_host:=0.0.0.0. Its default CORS origins already allow the web UI onlocalhost:3000./diagnosticsstays opt-in viaenable_diagnostic_bridge:=true.medkit_hero.gif.Hidden anchors keep the old deep links working:
#run-it-in-5-minutesand#vs-standard-ros-2-diagnostics.Checklist