Skip to content

docs: state plainly that openamrobot-comm is planned and empty - #99

Draft
anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/comm-overview-status
Draft

anandgawai123456-glitch wants to merge 1 commit into
mainfrom
docs/comm-overview-status

Conversation

@anandgawai123456-glitch

Copy link
Copy Markdown
Contributor

Summary

Replaces the empty template in reference/openamrobot-comm/overview.md with an honest status page. openamrobot-comm is Planned, no code yet: its README calls the layout scaffolding, and every subdirectory I listed holds only empty directories or .gitkeep files. The page says what the repository is for, what it contains today, and where to look instead (interfaces, platform-sw, platform-fw, ui). It does not invent a protocol, schema, topic, port or version.

The other six pages under reference/openamrobot-comm/ are unchanged. They are still the generic "Under development" template, which is a question for the docs owner and project lead (see Status).

Evidence

  • Base: main at 84122acb709ff42eb00bbaef98252641513fb41e. Head: 8789bb6c30a8b88537b25387daee8a9d450600b6.
  • Sources read: openamrobot-comm main at 73fa694: README.md, the root listing, and the listings of protocols/, middleware/, schemas/, examples/, tools/, tests/ and docs/ and its subfolders. Also its PR list and open issues.
  • 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 page for audits, e-mail addresses, credentials, Use_Case_1 text and the company registration number found nothing.
  • Files changed: docs/reference/openamrobot-comm/overview.md and CHANGELOG.md.

Not verified

  • The examples/ subfolders (cpp, javascript, python) were listed by name only. The page says "empty directories or placeholders" for that group, and I did not open them.
  • STATE.md of the comm repo could not be decoded in my session, so it was not read.
  • The link to the interface reference points at a page that is still a placeholder on main. It becomes useful once docs: index the shared interface packages and navigation messages #96 merges. It does not break the build.
  • 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 work-package owner's adopt, adapt or reject before it is marked ready. Decision for the project lead: should the six remaining template pages of repositories with no content yet be marked "planned" or left as they are? This PR does not change them. It touches the same CHANGELOG.md section as #96 to #98, so expect a trivial merge conflict there.

Replace the empty template in reference/openamrobot-comm/overview.md with a status
page: the repository is Planned with no code, only empty scaffolding, checked against
openamrobot-comm main at 73fa694. It says what the repository is for and where to look
instead, and invents no protocol, schema or version.

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