docs: MkDocs scaffold + ADR-0001 + README quickstart (closes #32) #39

Merged
eho merged 1 commits from feat/32-docs-scaffold into main 2026-06-03 12:13:33 +00:00
Owner

Implements S-00-e (#32) — the last Iteration 0 sub-slice.

  • mkdocs.yml (Material theme + nav), docs/index.md.
  • docs/architecture/adr-0001-loose-coupling.md — first ADR, Nygard template, records the §8 loose-coupling stance.
  • README quickstart rewritten: correct clone URL, real prerequisites, make ci + compose smoke, sub-10-minute path; docs-build instructions. .venv/ + site/ gitignored.

Verified: mkdocs build succeeds (mkdocs-material 1.6.1); make lint/build/unit green.

closes #32

🤖 Generated with Claude Code

Implements **S-00-e** (#32) — the last Iteration 0 sub-slice. - `mkdocs.yml` (Material theme + nav), `docs/index.md`. - `docs/architecture/adr-0001-loose-coupling.md` — first ADR, Nygard template, records the §8 loose-coupling stance. - README quickstart rewritten: correct clone URL, real prerequisites, `make ci` + compose smoke, sub-10-minute path; docs-build instructions. `.venv/` + `site/` gitignored. **Verified:** `mkdocs build` succeeds (mkdocs-material 1.6.1); `make lint/build/unit` green. closes #32 🤖 Generated with [Claude Code](https://claude.com/claude-code)
eho added 1 commit 2026-06-03 12:13:21 +00:00
docs: MkDocs scaffold, ADR-0001, README quickstart (refs #32)
Some checks failed
CI / lint (pull_request) Has been cancelled
CI / build (pull_request) Has been cancelled
CI / unit (pull_request) Has been cancelled
CI / compose-smoke (pull_request) Has been cancelled
77297a8d8e
Add mkdocs.yml (Material theme + nav), docs/index.md, and the first ADR
(docs/architecture/adr-0001-loose-coupling.md, Nygard template) recording
the loose-coupling stance from CLAUDE.md §8. Rewrite the README quickstart
to be accurate and reach a green local environment in under 10 minutes
(correct clone URL, .NET 10 + container-engine prereqs, `make ci` and the
compose smoke), and document building the docs site. Ignore .venv/ and site/.

Verified: `mkdocs build` succeeds; `make lint/build/unit` green.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
eho merged commit e85774d482 into main 2026-06-03 12:13:33 +00:00
Sign in to join this conversation.