Skip to content

docs: index the shared interface packages and navigation messages - #96

Draft
anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/interfaces-reference-nav-msgs
Draft

anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/interfaces-reference-nav-msgs

Conversation

@anandgawai123456-glitch

Copy link
Copy Markdown
Contributor

Summary

Replaces the empty template in docs/reference/openamrobot-interfaces/reference.md with an index of the shared ROS 2 interface packages and the navigation messages. It links to the canonical definitions in openamrobot-interfaces and 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.md or working-with-interfaces.md, which are in #74.

Evidence

  • Base: main at 84122acb709ff42eb00bbaef98252641513fb41e. Head: 512d234f00a5bedf44b4c1395fae67799df5c1e5.
  • Sources read: openamrobot-interfaces main at 50ed777: root README.md, ros2/openamr_nav_msgs/README.md, ros2/openamr_nav_msgs/msg/StopState.msg, and the file listings of ros2/.
  • Every upstream link target was confirmed to exist with the GitHub contents API (CONTRACT.md, both package READMEs, docs/verification.md, docs/schema-validation.md).
  • Local commands, in a clean clone with the pinned requirements.txt:
    • mkdocs build --strict: built without errors.
    • bash scripts/check_docs.sh: "Documentation check passed with 0 warning(s)".
  • Files changed: 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_1 requirement text. The private audits repository is not referenced.

Not verified

  • No ROS build, runtime, producer or hardware check. The StopState description repeats the comment in the .msg file and says so; it does not confirm the behaviour.
  • The CONTRACT.md content was linked, not read in full for this PR.
  • The openamr_ui_msgs row is based on the package listing and its README link only.
  • Link-check CI and the live deploy: not run for this PR (deploy is skipped on PRs).
  • No independent ChatGPT review has been done yet.

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.

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]>
@cla-assistant

cla-assistant Bot commented Nov 22, 2026

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant