Repository navigation
docs: state plainly that openamrobot-comm is planned and empty - #99
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-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]>
|
|
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
reference/openamrobot-comm/overview.mdwith an honest status page.openamrobot-commis Planned, no code yet: its README calls the layout scaffolding, and every subdirectory I listed holds only empty directories or.gitkeepfiles. 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
mainat84122acb709ff42eb00bbaef98252641513fb41e. Head:8789bb6c30a8b88537b25387daee8a9d450600b6.openamrobot-commmainat73fa694:README.md, the root listing, and the listings ofprotocols/,middleware/,schemas/,examples/,tools/,tests/anddocs/and its subfolders. Also its PR list and open issues.requirements.txt:mkdocs build --strictbuilt without warnings or errors;bash scripts/check_docs.shpassed with 0 warnings.audits, e-mail addresses, credentials,Use_Case_1text and the company registration number found nothing.docs/reference/openamrobot-comm/overview.mdandCHANGELOG.md.Not verified
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.mdof the comm repo could not be decoded in my session, so it was not read.main. It becomes useful once docs: index the shared interface packages and navigation messages #96 merges. It does not break the build.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.mdsection as #96 to #98, so expect a trivial merge conflict there.