Skip to content

docs(adr): ADR-004 — README single-source derivation (author .adoc, derive .md per declared consumer)#474

Merged
hyperpolymath merged 1 commit into
mainfrom
docs/adr-004-readme-single-source-derive
Jul 7, 2026
Merged

docs(adr): ADR-004 — README single-source derivation (author .adoc, derive .md per declared consumer)#474
hyperpolymath merged 1 commit into
mainfrom
docs/adr-004-readme-single-source-derive

Conversation

@hyperpolymath

Copy link
Copy Markdown
Owner

Purpose

Owner-ratification PR — deliberately NOT armed for auto-merge.

Design document for the README format way-forward, per the 2026-07-07 ratification ("ratify, but standards-design first"). No workflow code in this PR.

What it proposes

  • Principle: author READMEs once in AsciiDoc; CI derives README.md only for repos that declare a Markdown consumer; derived files are never hand-edited.
  • Consumer declaration: a (publishing ...) block in descriptiles ECOSYSTEM.a2ml (standalone PUBLISHING.a2ml flagged as the alternative). No declaration ⇒ no derived README, ever — the anti-runaway guard.
  • Pipeline: readme-derive.yml reusable workflow — asciidoctor-reducer → pandoc (docbook→gfm) → fail-closed ≥98% vocab-preservation gate → generated-file stamp → freshness check (fail-and-tell).
  • Rollout: A (this ADR) → B (build workflow) → C (pilot: flip boj-server + hyperpolymath/hyperpolymath, ratified) → D (opt-in + rhodibot broadening).

Context

Replaces the two-repo exception lore that caused the June 2026 estate-wide .adoc→.md runaway (~33 repos, reverted 2026-06-29). Root cause was policy-as-prose; this makes it policy-as-configuration executed by deterministic CI.

Open items for owner veto (§ Open items)

  1. Block location: ECOSYSTEM.a2ml vs standalone PUBLISHING.a2ml
  2. Gate threshold (98% proposed)
  3. Freshness mode: fail-and-tell vs auto-commit

🤖 Generated with Claude Code

…ive .md per declared consumer)

Design-first per owner ratification 2026-07-07: principle accepted
conditional on standards-design review before any workflow code.
Proposes the descriptiles publishing block, the gated readme-derive
reusable workflow, guardrails, and the boj-server + profile-repo pilot.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@sonarqubecloud

sonarqubecloud Bot commented Jul 7, 2026

Copy link
Copy Markdown

@hyperpolymath
hyperpolymath marked this pull request as ready for review July 7, 2026 10:17
@hyperpolymath
hyperpolymath merged commit 68cadb2 into main Jul 7, 2026
23 checks passed
@hyperpolymath
hyperpolymath deleted the docs/adr-004-readme-single-source-derive branch July 7, 2026 10:18
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.

1 participant