Skip to content

Repository navigation

v0.3.0 — living-docs add-on

Choose a tag to compare

View all tags
@PBNZ PBNZ released this 13 Jul 03:58
· 17 commits to main since this release
v0.3.0
c49deb1
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Doc consistency made structural instead of judgment-based.

Added

  • A living-docs add-on for /new-repo (opt-in, orthogonal to type and tier): volatile shared facts live once in docs/STATE.json, README.md/docs/**/*.md render them via marker-delimited state blocks, and a cross-platform scripts/check-docs.ps1 (pwsh 7) enforces consistency — blocks match the state file, no stale/future as_of dates, no superseded-content markers in the runbook, one table-separator style — locally and in a Core-tier docs.yml workflow. Stamps a current-state-only docs/RUNBOOK.md skeleton and adds living-docs ground rules to the scaffolded AGENTS.md (ADR-0006).
  • Two new repo-standard docs: standard/living-docs.md (the pattern, plus an adopt-in-an-existing-repo recipe) and standard/doc-style.md (deterministic doc formatting — one table style, ISO dates, fixed status words — so many sessions/models write like one author). The pre-commit / pre-PR checklists gain matching doc-consistency steps.
  • A smoke test for the add-on (scripts/smoke_test_living_docs.ps1): stamps the templates, renders the state blocks, and proves the check fails on each enforced problem class (drifted block, stale date, superseded marker, malformed table separator). CI runs it on ubuntu-latest.
  • A cross-platform smoke test for the powershell-module templates (scripts/smoke_test_powershell_module.ps1), run by CI with pwsh on ubuntu-latest (ADR-0005).

Changed

  • The {{Guid}} placeholder instruction in /new-repo is now shell-agnostic.
  • GitHub Actions pinned in CI and the bundled workflow templates bumped off the deprecated Node 20 runtime (actions/checkout@v7, actions/setup-python@v6, googleapis/release-please-action@v5).

Full changelog: v0.2.0...v0.3.0

Assets 2
Loading