Skip to content

adr: relocate ADRs to /adr; add ADR-0002 (location) + retrospective ADR-0003-0014#73

Open
JimCollinson wants to merge 1 commit into
mainfrom
adr/relocate-and-retrospective-records
Open

adr: relocate ADRs to /adr; add ADR-0002 (location) + retrospective ADR-0003-0014#73
JimCollinson wants to merge 1 commit into
mainfrom
adr/relocate-and-retrospective-records

Conversation

@JimCollinson

@JimCollinson JimCollinson commented Jul 15, 2026

Copy link
Copy Markdown
Collaborator

Summary

Two things in one change:

  1. Relocate the ADR home from docs/adr/ to repo-root /adr. In this repo docs/ is the published GitBook product (.gitbook.yaml sets root: ./docs/), so ADRs under docs/ would leak into the public developer-docs site (nav / search / llms.txt) and get swept by the docs tooling. Recorded as ADR-0002.
  2. Add the retrospective decision record for the docs automation and the developer skill — ADR-0003 through ADR-0014 — capturing decisions that were made and implemented before the ADR process (PR ci: add ADR governance compliance #56) existed.

What changed

  • git mv docs/adr → adr (moves ADR-0001, TEMPLATE.md, TOOLING.md, README.md).
  • Repointed the governance config at the new location:
    • .adr-kit.yamladr_directory: adr
    • scripts/adr-governance.pyADR_DIR = Path("adr")
    • .github/workflows/adr-governance.yml → path filters → adr/**
  • Added adr/ADR-0002 … ADR-0014.
  • Added planning/skill-open-questions.md (open items the skill ADRs leave — see below).

The ADRs

  • 0002 — ADRs live at /adr, not docs/adr (this change; a normal prospective decision)

Automation

  • 0003 — verification-block source-of-truth model
  • 0004 — tiered execution: deterministic detection / efficient-model metadata sweeps / frontier-model prose
  • 0005 — subscription-billed daily scheduled routine (over repository_dispatch webhooks and API-billed CI)
  • 0006 — two-track PR envelope: metadata "sweeps" vs prose "pro sweeps", enforced by branch-scoped guards
  • 0007 — fail-closed operation and the GitHub artifact topology

Docs platform & authoring

  • 0008 — GitBook + GitHub, serving a dual human/LLM audience
  • 0009 — human review gate now, with a path to full automation (AI-panel review + human escalation)
  • 0010CLAUDE.md as the enforced authoring-constraints contract
  • 0011 — information architecture & content design (route-first navigation with Diátaxis)

Developer skill

  • 0012 — skill purpose / single-file format / in-repo location / vendor-agnostic distribution
  • 0013 — skill freshness: three-part staleness defence + content tiering
  • 0014 — skill maintenance workflow + feeds_skills registry wiring

Status: Accepted, retrospectively

ADR-0003–0014 record decisions taken before this ADR process existed. They are marked Accepted with an explicit Acceptance: Retrospective line — ratified by the implementation already built on them and by this review pass, not by prospective pre-implementation review. This gives them immutability (protection from casual edits) while staying honest about how acceptance happened. ADR-0002 is an ordinary prospective decision.

Open items (non-blocking)

Tracked in planning/skill-open-questions.md — most notably the skill's canonical name (autonomi-developer) vs the current on-disk skills/start/, and a possible future migration to WithAutonomi/skills. These resolve later via superseding ADRs, not edits.

Validation

  • python3 scripts/adr-governance.py passes against the 14 ADRs at /adr (verified on a mirror of this branch: ADR governance passed (14 ADR file(s) checked)).
  • The ADR Governance check runs on this PR against adr/**; sweep-guard / prose-guard / sweep-sha-reachability green-skip on this non-claude/* branch.

Reviewer notes

  • This re-points the team-standard ADR location for this repo only, via the standard's own adr_directory knob — the shared mechanics (template, lifecycle, immutable-Accepted enforcement) are untouched. Full rationale in ADR-0002.
  • ADRs were AI-drafted and human-reviewed per the process; several were revised across review (model tiering in 0004, vendor-agnostic distribution and the naming tension in 0012).

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