docs: publish documentation as a GitHub Pages site and run a full quality pass#146

Merged

sourcehawk merged 37 commits into

mainfrom

worktree-docs-github-pages

Jun 2, 2026

Commits on Jun 2, 2026

docs: scaffold Material for MkDocs site, make targets, and Pages workflow
sourcehawk
committed
docs: add landing page, getting-started stub, and fix out-of-tree links for strict build

sourcehawk
and
claude
committed
docs: address site preview feedback (cards, nav, duplicate TOC)

sourcehawk
and
claude
committed
docs: rewrite concept pages to writing-docs standard

sourcehawk
and
claude
committed
docs: add getting-started tutorial and rework landing page

sourcehawk
and
claude
committed
docs: rewrite primitive reference pages to canonical template

sourcehawk
and
claude
committed
docs: rewrite guidelines, testing, and compatibility guides

sourcehawk
and
claude
committed
example: genericize version-matrix naming; sync testing docs

sourcehawk
and
claude
committed
docs: remove em dashes from rewritten pages

sourcehawk
and
claude
committed
docs: strengthen landing page pitch and move navigation above it

sourcehawk
and
claude
committed
docs: adopt feature.NewBooleanGate across docs and examples

sourcehawk
and
claude
committed
docs: show a concrete version-gated example in the getting-started note

sourcehawk
and
claude
committed
example: demonstrate three-layer testing in mutations-and-gating

sourcehawk
and
claude
committed
docs: rework getting-started Step 6 to use the real factory and introspection

sourcehawk
and
claude
committed
example: standardize mutations-and-gating resource and component tests on goldengen

sourcehawk
and
claude
committed
example: make resource and component tests consistent across examples

sourcehawk
and
claude
committed
docs: restructure testing guide around the three testing layers

sourcehawk
and
claude
committed
docs: simplify getting-started resource test to a plain golden

sourcehawk
and
claude
committed
docs: fix testing guide snippets and a broken note admonition

sourcehawk
and
claude
committed
docs: drop the manual FiringSet section in favor of goldengen.Resource

sourcehawk
and
claude
committed
docs: remove forward reference to FiringSet in the goldengen intro
sourcehawk
committed
docs: clarify that AssertComplete checks coverage, not firing

sourcehawk
and
claude
committed
docs: add a summary table contrasting Requires, Forbids, and AssertComplete

sourcehawk
and
claude
committed
docs: format the LoadMatrix call across lines in canonical gofmt style
sourcehawk
committed
docs: clarify that LoadMatrix specs are shared across versions and need deep copy

sourcehawk
and
claude
committed
docs: show the buildUnit body in the LoadMatrix example

sourcehawk
and
claude
committed
docs: explain that Run invokes the LoadMatrix build function

sourcehawk
and
claude
committed
docs: writing-docs pass on the testing guide

sourcehawk
and
claude
committed
docs: realign the version-coverage guideline to recommend goldengen

sourcehawk
and
claude
committed
docs: render the component architecture block as a centered Mermaid diagram

sourcehawk
and
claude
committed
docs: bold each node headline in the component architecture diagram
sourcehawk
committed
docs: clarify the WithResource-to-IncludeWhen untrack path and its owner-reference caveat

sourcehawk
and
claude
committed
docs: fix the plan-and-apply Mermaid sequence diagram not rendering
sourcehawk
committed
docs: adopt OrphanWhen in the component resource-options docs

sourcehawk
and
claude
committed
docs: trim README to a minimal entry point that links to the docs site

sourcehawk
and
claude
committed
ci: publish docs on release instead of on every default-branch merge
sourcehawk
committed
ci: scope Pages and OIDC permissions to the deploy job only
sourcehawk
committed