Repository navigation
docs: index the shared interface packages and navigation messages - #96
Draft
anandgawai123456-glitch wants to merge 1 commit into
Draft
anandgawai123456-glitch wants to merge 1 commit into
anandgawai123456-glitch wants to merge 1 commit into
Conversation
Replace the empty template in reference/openamrobot-interfaces/reference.md with an index of the ros2/ packages and navigation messages, checked against openamrobot-interfaces main at 50ed777. It links to the canonical definitions and copies no fields, constants or reason codes. Co-Authored-By: Claude Sonnet 5.5 <[email protected]> Signed-off-by: Anand Gawai <[email protected]>
This was referenced Nov 22, 2026
|
|
3 of 4 tasks
This branch has not been deployed
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.
Summary
Replaces the empty template in
docs/reference/openamrobot-interfaces/reference.mdwith an index of the shared ROS 2 interface packages and the navigation messages. It links to the canonical definitions inopenamrobot-interfacesand copies no fields, constants, reason codes or version numbers.Part of keeping the site aligned with the repositories (issue #24 area). It does not touch
setup.mdorworking-with-interfaces.md, which are in #74.Evidence
mainat84122acb709ff42eb00bbaef98252641513fb41e. Head:512d234f00a5bedf44b4c1395fae67799df5c1e5.openamrobot-interfacesmainat50ed777: rootREADME.md,ros2/openamr_nav_msgs/README.md,ros2/openamr_nav_msgs/msg/StopState.msg, and the file listings ofros2/.docs/verification.md,docs/schema-validation.md).requirements.txt:mkdocs build --strict: built without errors.bash scripts/check_docs.sh: "Documentation check passed with 0 warning(s)".docs/reference/openamrobot-interfaces/reference.md,CHANGELOG.md.Publication check
No internal document links, prices, contact data or credentials, and no private person, customer or partner names. No
Use_Case_1requirement text. The private audits repository is not referenced.Not verified
StopStatedescription repeats the comment in the.msgfile and says so; it does not confirm the behaviour.CONTRACT.mdcontent was linked, not read in full for this PR.openamr_ui_msgsrow is based on the package listing and its README link only.AI disclosure
Drafted with Claude Code (Claude Sonnet 5.5): the page text and the changelog entry. Sources, links and commands were read or run in the session. The contributor reviews and is responsible for the content.
Status
Draft. Needs the technical reviewer (navigation and interfaces) and the work-package owner's adopt, adapt or reject before it is marked ready.