Skip to content

docs: describe the manifest, pinned snapshot, checks and drivers - #98

Draft
anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/manifest-reference-pages
Draft

anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/manifest-reference-pages

Conversation

@anandgawai123456-glitch

Copy link
Copy Markdown
Contributor

Summary

Replaces three empty templates under reference/openamrobot-manifest/ (concepts, setup, reference) with content from the openamrobot-manifest README and STATE.md: the development manifest versus the pinned rc.1 snapshot, how to import and validate a workspace, and the files, check stages and source drivers. configuration, tutorials and troubleshooting are left unchanged.

The rc.1 snapshot is described as a candidate, as the README states ("not final rc.1 acceptance"). Pinned commits are linked and not copied, because open PRs #22 and #23 in that repository refresh them.

Evidence

  • Base: main at 84122acb709ff42eb00bbaef98252641513fb41e. Head: ad15e419ac675dcfc3b9a4fd43f441d667b2ab08.
  • Sources read: openamrobot-manifest main at 5b782ac: README.md, STATE.md, the repo file list, the releases/ listing and its open PRs.
  • Local commands, in a clean clone with the pinned requirements.txt: mkdocs build --strict built without warnings or errors; bash scripts/check_docs.sh passed with 0 warnings.
  • A scan of the three pages for audits, e-mail addresses, credentials, Use_Case_1 text and the company registration number found nothing.
  • Files changed: the three pages and CHANGELOG.md.

Not verified

  • The vcs, colcon, check_manifest.py and verify_jazzy_drivers.sh commands are summarised from the README. They were not run here.
  • The tool files under tools/ and the .repos files were listed but not opened. The check-stage descriptions come from the README.
  • The driver hardware and transport statements (RPLIDAR S3 over USB to UART, micro-ROS over UDP) are repeated from the README, and are not checked against the hardware repositories.
  • No link-check CI or deploy has run for this PR. 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 and commands were read or run in the session. The contributor reviews and is responsible for the content.

Status

Draft. Needs the technical reviewer for the manifest and the work-package owner's adopt, adapt or reject before it is marked ready. It touches the same CHANGELOG.md section as #96 and #97, so expect a trivial merge conflict there.

Replace three empty templates under reference/openamrobot-manifest with the
development manifest versus the pinned rc.1 snapshot, the import and validation
procedures, and the files, check stages and source drivers, checked against
openamrobot-manifest main at 5b782ac. Pinned commits are linked, not copied.

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