📝 docs(adr): homogenize 23 ADRs + rewrite README (Tâche 7 migration) #18

Merged
arcodange merged 2 commits from feature/homogenize-adrs into main 2026-05-03 11:01:14 +02:00
Owner

Summary

Homogenize all 23 ADRs to a single canonical header format, and rewrite adr/README.md to match the actual state of the corpus.

This is Tâche 7 of the ARCODANGE Phase 1 migration (Claude Code → Mistral Vibe). Independent from PR #17 (Tâche 6 — restructure AGENTS.md) — both can merge in any order. No code changes; only documentation.

Changes

1. Homogenize 21 ADR headers (commit db09d0a)

The audit (Tâche 6 Phase A, Mistral intent-router agent, 2026-05-02) had identified 3 inconsistent header formats :

  • F1 — list bullets (* Status: / * Date: / * Deciders:) : 11 ADRs (0001-0008, 0011, 0014, 0023)
  • F2 — bold fields (**Status:** / **Date:** / **Authors:**) : 9 ADRs (0009, 0010, 0012, 0013, 0015, 0016, 0017, 0018, 0019)
  • F3 — dedicated section (## Status\n**Value** ✅) : 5 ADRs (0020, 0021, 0022, 0024, 0025)

Plus mixed metadata names (Authors / Deciders / Decision Date / Implementation Date / Implementation Status / Last Updated) and decorative emojis on status values made the corpus hard to scan or template against.

Canonical format adopted (see adr/README.md for full template) :

# NN. Title

**Status:** <Proposed | Accepted | Implemented | Partially Implemented | Approved | Rejected | Deferred | Deprecated | Superseded by ADR-NNNN>
**Date:** YYYY-MM-DD
**Authors:** Name(s)

[optional **Field:** ... lines]

## Context...

Transformations applied (via /tmp/homogenize-adrs.py script, 23 files scanned, 21 modified — 0010 and 0012 were already conform) :

  • F1 list bullets → bold fields
  • F2 cleanup : **Deciders:****Authors:**, strip status emojis
  • F3 sections : ## Status\n**Value** ✅**Status:** Value (single line)
  • Strip decorative emojis from **Status:** and **Implementation Status:**
  • Convert * Last Updated: / * Implementation Status: / * Decision Drivers: / * Decision Date: to bold
  • Date typo fix : 2024-04-XX2026-04-XX for ADRs 0018, 0019 (off-by-2-years in original)
  • Normalize multiple blank lines after header (max 1)

ADR body content is preserved unchanged. Only headers transformed.

2. Rewrite adr/README.md (commit d64ab02)

Previous README had multiple inconsistencies :

  • Index table listed wrong titles for ADRs 0010-0021 (looked like an aspirational forecast that never matched reality — e.g. "0011 = Trunk-Based Development" but real 0011 is absent and Trunk-Based Development is actually 0017)
  • Listed entries for ADRs 0011 (validation library) and 0014 (gRPC) but these files do not exist in the repo
  • 0024 (BDD Test Organization) was missing from the detail list
  • Template still showed the obsolete F1 format (* Status:)
  • Decorative emojis on every status entry

Rewrite :

  • Index table regenerated from actual file contents (title from H1, status from **Status:** line) — emoji-free, accurate
  • Notes that 0011 / 0014 are not currently in use (reserved)
  • Updated template block matches the canonical format
  • Status Legend extended with Approved, Partially Implemented, Deferred
  • Added note that 0026 is the next free number for new ADRs

Test plan

  • All 23 ADRs follow **Status:** / **Date:** / **Authors:** (verified via grep)
  • No more occurrences of * Status: (F1) or ## Status (F3) in any ADR header
  • No more emojis on **Status:** lines
  • adr/README.md index links resolve to existing files (no more 0011 / 0014 dead links)
  • Pre-commit hooks pass (go mod tidy, go fmt, swag fmt)

Migration context

Part of Phase 1 of the ARCODANGE migration from Claude Code to Mistral Vibe. Tâche 7 of the curriculum.

Independent from PR #17 (which restructures AGENTS.md). The two PRs touch disjoint files — no merge conflict expected when both are merged.

🤖 Generated with Claude Code (Opus 4.7, 1M context). Mistral Vibe (intent-router agent / mistral-medium-3.5) did the original audit identifying the 3 formats during Tâche 6 Phase A.

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com
Co-Authored-By: Mistral Vibe (devstral-2 / mistral-medium-3.5)

## Summary Homogenize all 23 ADRs to a single canonical header format, and rewrite `adr/README.md` to match the actual state of the corpus. This is **Tâche 7** of the ARCODANGE Phase 1 migration (Claude Code → Mistral Vibe). Independent from PR #17 (Tâche 6 — restructure AGENTS.md) — both can merge in any order. No code changes; only documentation. ## Changes ### 1. Homogenize 21 ADR headers (commit `db09d0a`) The audit (Tâche 6 Phase A, Mistral intent-router agent, 2026-05-02) had identified **3 inconsistent header formats** : - **F1** — list bullets (`* Status:` / `* Date:` / `* Deciders:`) : 11 ADRs (0001-0008, 0011, 0014, 0023) - **F2** — bold fields (`**Status:**` / `**Date:**` / `**Authors:**`) : 9 ADRs (0009, 0010, 0012, 0013, 0015, 0016, 0017, 0018, 0019) - **F3** — dedicated section (`## Status\n**Value** ✅`) : 5 ADRs (0020, 0021, 0022, 0024, 0025) Plus mixed metadata names (Authors / Deciders / Decision Date / Implementation Date / Implementation Status / Last Updated) and decorative emojis on status values made the corpus hard to scan or template against. **Canonical format adopted** (see `adr/README.md` for full template) : ```markdown # NN. Title **Status:** <Proposed | Accepted | Implemented | Partially Implemented | Approved | Rejected | Deferred | Deprecated | Superseded by ADR-NNNN> **Date:** YYYY-MM-DD **Authors:** Name(s) [optional **Field:** ... lines] ## Context... ``` **Transformations applied** (via `/tmp/homogenize-adrs.py` script, 23 files scanned, 21 modified — 0010 and 0012 were already conform) : - F1 list bullets → bold fields - F2 cleanup : `**Deciders:**` → `**Authors:**`, strip status emojis - F3 sections : `## Status\n**Value** ✅` → `**Status:** Value` (single line) - Strip decorative emojis from `**Status:**` and `**Implementation Status:**` - Convert `* Last Updated:` / `* Implementation Status:` / `* Decision Drivers:` / `* Decision Date:` to bold - Date typo fix : `2024-04-XX` → `2026-04-XX` for ADRs 0018, 0019 (off-by-2-years in original) - Normalize multiple blank lines after header (max 1) **ADR body content is preserved unchanged.** Only headers transformed. ### 2. Rewrite `adr/README.md` (commit `d64ab02`) Previous README had multiple inconsistencies : - Index table listed wrong titles for ADRs 0010-0021 (looked like an aspirational forecast that never matched reality — e.g. "0011 = Trunk-Based Development" but real 0011 is absent and Trunk-Based Development is actually 0017) - Listed entries for ADRs 0011 (validation library) and 0014 (gRPC) but **these files do not exist** in the repo - 0024 (BDD Test Organization) was missing from the detail list - Template still showed the obsolete F1 format (`* Status:`) - Decorative emojis on every status entry Rewrite : - Index table **regenerated from actual file contents** (title from H1, status from `**Status:**` line) — emoji-free, accurate - Notes that 0011 / 0014 are not currently in use (reserved) - Updated template block matches the canonical format - Status Legend extended with `Approved`, `Partially Implemented`, `Deferred` - Added note that 0026 is the next free number for new ADRs ## Test plan - [x] All 23 ADRs follow `**Status:**` / `**Date:**` / `**Authors:**` (verified via grep) - [x] No more occurrences of `* Status:` (F1) or `## Status` (F3) in any ADR header - [x] No more emojis on `**Status:**` lines - [x] `adr/README.md` index links resolve to existing files (no more 0011 / 0014 dead links) - [x] Pre-commit hooks pass (`go mod tidy`, `go fmt`, `swag fmt`) ## Migration context Part of Phase 1 of the ARCODANGE migration from Claude Code to Mistral Vibe. Tâche 7 of the curriculum. Independent from PR #17 (which restructures `AGENTS.md`). The two PRs touch disjoint files — no merge conflict expected when both are merged. 🤖 Generated with [Claude Code](https://claude.com/claude-code) (Opus 4.7, 1M context). Mistral Vibe (intent-router agent / mistral-medium-3.5) did the original audit identifying the 3 formats during Tâche 6 Phase A. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com> Co-Authored-By: Mistral Vibe (devstral-2 / mistral-medium-3.5)
arcodange added 2 commits 2026-05-03 00:28:49 +02:00
Audit 2026-05-02 (Tâche 6 Phase A) had identified 3 inconsistent
formats across the ADR corpus :
- F1 list bullets : `* Status:` / `* Date:` / `* Deciders:` (11 ADRs)
- F2 bold fields : `**Status:**` / `**Date:**` / `**Authors:**` (9 ADRs)
- F3 dedicated section : `## Status\n**Value** ` (5 ADRs)

Mixed metadata names (Authors / Deciders / Decision Date / Implementation
Date / Implementation Status / Last Updated) and decorative emojis on
status values made the corpus hard to scan or template against.

Canonical format adopted (see adr/README.md for full template) :
    # NN. Title

    **Status:** <Proposed|Accepted|Implemented|Partially Implemented|
                  Approved|Rejected|Deferred|Deprecated|Superseded by ADR-NNNN>
    **Date:** YYYY-MM-DD
    **Authors:** Name(s)
    [optional **Field:** ... lines]

    ## Context...

Transformations applied (via /tmp/homogenize-adrs.py) :
- F1 list bullets → bold fields
- F2 cleanup : `**Deciders:**` → `**Authors:**`, strip status emojis
- F3 sections : `## Status\n**Value** ` → `**Status:** Value`
- Strip decorative emojis from `**Status:**` and `**Implementation Status:**`
- Convert any `* Implementation Status:` / `* Last Updated:` /
  `* Decision Drivers:` / `* Decision Date:` to bold equivalents
- Date typo fix : `2024-04-XX` → `2026-04-XX` for ADRs 0018, 0019
  (already noted in PR #17 but here re-applied since branch starts
  from origin/main pre-PR17)
- Normalize multiple blank lines after header (max 1)

21 / 23 ADRs modified. 0010 and 0012 were already conform.
0011 and 0014 do not exist in the repo (cf. README index update).

Body content of each ADR is preserved unchanged.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
The previous README had multiple inconsistencies discovered during
ADR audit (Tâche 6 Phase A) :
- Index table listed wrong titles for ADRs 0010-0021 (looked like
  an aspirational forecast that never matched reality)
- Listed entries for ADRs 0011 (validation library) and 0014 (gRPC)
  but these files do not exist in the repo
- 0024 (BDD Test Organization) was missing from the detail list
- Template still showed the F1 format (* Status:) which is now
  obsolete (cf. previous commit homogenizing all ADRs)
- Decorative emojis on every status entry of the index

This rewrite :
- Index table regenerated from actual file contents (title from H1,
  status from `**Status:**` line). Single emoji-free format.
- Notes that 0011 / 0014 are not currently in use (reserved).
- Updated template block matches canonical format adopted in
  homogenization commit.
- Status Legend extended with Approved (used by ADR-0017),
  Partially Implemented (0009, 0013), Deferred, etc.
- Added note that 0026 is the next free number for new ADRs.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
arcodange merged commit a24b4fdb3b into main 2026-05-03 11:01:14 +02:00
arcodange deleted branch feature/homogenize-adrs 2026-05-03 11:01:14 +02:00
Sign in to join this conversation.
No Reviewers
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: arcodange/dance-lessons-coach#18