Skip to content

Greatly reduce documentation: 18 ADRs → 1, delete archive docs, strip essay comments - #123

Merged
micahflee merged 1 commit into
mainfrom
docs/reduce-archive-documentation
Oct 11, 2026
Merged

micahflee merged 1 commit into
mainfrom
docs/reduce-archive-documentation

Conversation

@micahflee

Copy link
Copy Markdown
Member

Summary

 docs/
-├── adr/0001…0018                       # 18 ADRs, deleted
+├── adr/0001-shared-cyd-bluesky-archive-format.md
-├── bluesky-archive-conformance-matrix.md # deleted; matrix.py is the matrix
-└── bluesky-archive-fixtures.md           # deleted; recipe → fixtures README
+└── (agents/ untouched)
 testUtils/fixtures/bluesky-archive/README.md  # provenance + short regen recipe
 services/, hooks/, scripts/                    # ~600 essay comment lines stripped
  • One new ADR: the shared Cyd Bluesky archive format, whose normative contract
    is docs/archive/bluesky/v2/ in the cyd repo, mirrored here as the pinned
    contract bundle; conformance is enforced by tests in both repos.
  • ~67 ADR nnnn citations and all references to the two deleted docs are
    gone. One printed-string change: export-fixture.ts now prints
    "Provenance:" instead of naming the deleted doc.
  • Coordinated with a matching cleanup in lockdown-systems/cyd (#732).

Evidence

  • Before: 18 ADRs, two long docs, essay comments across ~44 source files.
    After: 1 ADR, short comments; npm run lint clean, npx jest 915
    passed / 0 failures, npm run test:archive-contract,
    test:archive-conformance, and test:archive-matrix → all 21 matrix rows
    pass against the pinned contract cbd2614….

Merge Danger

Door: two-way

Documentation and comments only; everything deleted lives in git history and
the commit is trivially revertible.

Blast Radius: low — agent docs that say "read relevant ADRs" now find one;
the conformance gate (test:archive-matrix, run in CI) is untouched.

Closes #111

(This was written by an LLM.)

Replace 18 ADRs with one on the shared Cyd Bluesky archive format,
delete docs/bluesky-archive-fixtures.md and
docs/bluesky-archive-conformance-matrix.md (the regeneration recipe
now lives in testUtils/fixtures/bluesky-archive/README.md, and the
matrix itself in scripts/archive-contract/matrix.py), and strip
essay-style comments and ADR citations from the source. Git history
remains the record of the deleted material.

Closes #111
@micahflee
micahflee merged commit 8828d8f into main Oct 11, 2026
1 check passed
@micahflee
micahflee deleted the docs/reduce-archive-documentation branch October 11, 2026 20:05
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.

Clean up docs and ADRs

1 participant