docs: consistency audit across README, docs site, and zenoh-bridge demo#64
Closed
oguzkaganozt wants to merge 2 commits into
Closed
docs: consistency audit across README, docs site, and zenoh-bridge demo#64oguzkaganozt wants to merge 2 commits into
oguzkaganozt wants to merge 2 commits into
Conversation
Align terminology and instructions across top-level README, deployment READMEs, and docs pages; update doc_env Dockerfile, Makefile, and deploy-docs workflow to match.
- Standardize "Open AD Kit" casing (drop "OpenADKit" / "Open Ad Kit" outliers). - Correct zenoh-bridge architecture diagram port label to 6081 (host-mapped). - Add descriptions to the samples deployments index for parity with parent. - Set REMOTE_PASSWORD=openadkit in zenoh-bridge compose so it matches the documented default; previously it was truncated to "o".
Collaborator
Author
|
Please review @youtalk @mitsudome-r |
This was referenced May 4, 2026
Collaborator
Author
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
1 participant
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
README.md, deployment READMEs, and the MkDocs site underdocs/.doc_env/Dockerfile,Makefiledoc targets, and.github/workflows/deploy-docs.yamlto stay consistent with the doc build.REMOTE_PASSWORD=openadkitindeployments/demos/zenoh-bridge/docker-compose.yaml— previously truncated too, which contradicted the documented default.docs/deployments/samples/index.md(added one-liner descriptions for the two samples, mirroringdocs/deployments/index.md).Test plan
mkdocs build(or themakedoc target) completes without warnings about broken links or missing nav entries../cloud.sh up -d+./edge.sh up -d) and verifyhttp://localhost:6081is reachable with passwordopenadkit.