docs: publish architecture map in docs site#243
Merged
Conversation
c17611d to
55d5bf0
Compare
zfields
approved these changes
May 22, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Publishes the repository’s architecture artifacts (overview page, interactive HTML map, and JSON) into the generated Sphinx docs output so they can be served from the documentation site (e.g., GitHub Pages).
Changes:
- Adds an Architecture section to the docs landing page and links it into the Sphinx toctree.
- Introduces a new
architecture.rstpage that links to the interactive map and JSON artifact. - Updates the docs CMake build to copy
docs/architecture/architecture.htmlanddocs/architecture/architecture.jsoninto the built site underarchitecture/.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/index.rst | Adds Architecture section and links the new architecture page in the toctree. |
| docs/CMakeLists.txt | Copies architecture HTML/JSON artifacts into the Sphinx build output directory. |
| docs/architecture/README.md | Documents the Sphinx entrypoint (docs/architecture.rst) for published architecture docs. |
| docs/architecture.rst | New Sphinx page linking to the interactive map + JSON artifact and pointing to ARCHITECTURE.md. |
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\n\n- Add a prominent Architecture section to the docs home page with links to the architecture overview, interactive map, and structured JSON artifact.\n- Add a Sphinx Architecture page linking to the interactive architecture map and structured JSON artifact.\n- Copy docs/architecture/architecture.html and docs/architecture/architecture.json into the generated docs site under architecture/ so GitHub Pages can serve them.\n- Document the Sphinx publishing entrypoint in the architecture docs README.\n\n## Verification\n\n- node docs/architecture/embed-architecture-json.mjs && git diff --exit-code docs/architecture/architecture.html\n- /home/ubuntu/.openclaw/workspace/scripts/check-resources.sh --label "note-c docs build" --min-ram-gb 4\n- Clean Docker docs build using ghcr.io/blues/note_c_ci:latest with a temporary CMake build directory.\n- Verified generated files exist:\n - docs/index.html with architecture links\n - docs/architecture.html\n - docs/architecture/architecture.html\n - docs/architecture/architecture.json\n- git diff --check\n