Repository navigation
Add a zero-warning Sphinx site with mermaid diagrams; rewrite the changelog to Common Changelog - #23
Merged
Merged
Conversation
…ngelog to Common Changelog - docs/ is a Sphinx (MyST) site that also reads on GitHub. architecture.md draws the contracts as mermaid diagrams (pipeline, smithy's state machine, the review round, red-amber-green, parallel [P] tasks, install.sh link placement, superpowers policy); the same ```mermaid blocks render on GitHub and, via myst_fence_as_directive, in Sphinx. - docs/_ext/damascus_sources.py generates the stage, agent, example, README, contributing and changelog pages from the shipped files at build time, so no contract is copied into docs/. - CI builds with sphinx-build -W --keep-going -n; toolchain pinned in docs/requirements.txt. - Fix forge's PRD template: its nested ``` fence closed the outer block early, so the template rendered broken on GitHub too. - CHANGELOG: one-line imperative entries with PR/commit references, a single-sentence notice, no CI/dotfile noise; [Unreleased] kept as the repo's documented deviation. README and CLAUDE.md document the docs build and the changelog rules. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NgVoHT9xneQu3hPZSabSGv
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01NgVoHT9xneQu3hPZSabSGv
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.
Sphinx docs (
docs/)docs/README.mdis the GitHub landing page for the folder;docs/index.mdis the Sphinx root.docs/architecture.mddraws the contracts as 7 mermaid diagrams: the pipeline and its artifacts, smithy's state machine, the adversarial review round, red-amber-green, parallel[P]tasks, howinstall.shplaces a link, and the superpowers policy. They are plain```mermaidblocks. GitHub renders them natively, andmyst_fence_as_directive = ["mermaid"]makes the same blockssphinxcontrib-mermaiddirectives in Sphinx.docs/.docs/_ext/damascus_sources.pygenerates the pages for the skills, agents, README, example trail,CLAUDE.mdand changelog intodocs/_generated/at build time. That directory is gitignored. The extension strips frontmatter and re-points relative links: to the generated page, todocs/, or to GitHub.sphinx docs (zero warnings)runssphinx-build -W --keep-going -n. The toolchain is pinned indocs/requirements.txtand is docs-only;install.shneeds none of it.```fence that closed the outer block early, so the template rendered broken on GitHub too. The outer fence is now four backticks.Changelog (Common Changelog)
[Unreleased]stays as the repo's one deliberate deviation, becauseCLAUDE.md, the changelog gate and the Release workflow depend on it. It now has a link definition.CLAUDE.md's release ritual says how to rewrite the notice and add the version link.README / CLAUDE.md
docs/row in Layout.CLAUDE.mddocuments the zero-warning build and the rule that contracts are never copied intodocs/.Verification
sphinx-build -W --keep-going -n: build succeeded, 0 warnings.tests/smoke.shpasses. Frontmatter lint and the example-trail check pass, andci.ymlparses.🤖 Generated with Claude Code
https://claude.ai/code/session_01NgVoHT9xneQu3hPZSabSGv
Generated by Claude Code