Skip to content

docs: publish architecture map in docs site#243

Merged
zfields merged 4 commits into
blues:masterfrom
zakoverflow:docs/publish-architecture-map
May 23, 2026
Merged

docs: publish architecture map in docs site#243
zfields merged 4 commits into
blues:masterfrom
zakoverflow:docs/publish-architecture-map

Conversation

@zakoverflow
Copy link
Copy Markdown
Contributor

@zakoverflow zakoverflow commented May 22, 2026

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

@zakoverflow zakoverflow force-pushed the docs/publish-architecture-map branch from c17611d to 55d5bf0 Compare May 22, 2026 21:09
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.rst page that links to the interactive map and JSON artifact.
  • Updates the docs CMake build to copy docs/architecture/architecture.html and docs/architecture/architecture.json into the built site under architecture/.

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.

Comment thread docs/index.rst Outdated
Comment thread docs/architecture.rst Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread docs/index.rst Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

Comment thread docs/architecture.rst Outdated
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 4 out of 4 changed files in this pull request and generated no new comments.

@zfields zfields merged commit 2f04f42 into blues:master May 23, 2026
12 checks passed
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.

3 participants