Skip to content

Greatly reduce documentation: 34 ADRs → 4, trim contract README, strip essay comments - #732

Merged
micahflee merged 2 commits into
mainfrom
docs/reduce-archive-documentation
Oct 11, 2026
Merged

micahflee merged 2 commits into
mainfrom
docs/reduce-archive-documentation

Conversation

@micahflee

@micahflee micahflee commented Oct 11, 2026 •

Copy link
Copy Markdown
Member

Summary

 docs/
 ├── adr/                  # 34 one-paragraph ADRs
-│   └── 0001…0034         # deleted; git history is the record
+│   ├── 0001-shared-cyd-bluesky-archive-format.md
+│   ├── 0002-protect-credentials-only.md        # platform-wide credential policy + Bluesky OAuth sessions
+│   └── 0003-bluesky-durable-jobs-and-content-addressed-storage.md
 └── archive/bluesky/v2/   # normative contract
     ├── README.md         # 179 → 135 lines: spec stays, story goes
     └── schema.sql, generate.py, fixtures/  # untouched
 src/                      # ~340 essay-style comment lines stripped
  • Three one-paragraph ADRs remain: the shared archive format (owned by
    docs/archive/bluesky/v2/ here, mirrored into Cyd Mobile as a pinned
    bundle), the credential policy (OS-protected storage where available for
    every platform's credentials, with disclosure otherwise; per-DID Bluesky
    OAuth sessions as the Bluesky-specific part), and the Bluesky data
    architecture (durable jobs, latest-observed records, content-addressed
    media).
  • Code comments were stripped to short functional one-liners; stale ADR nnnn citations are gone. No runtime behavior changed.
  • Coordinated with a matching cleanup in lockdown-systems/cyd-mobile
    (issue Prevent the computer from sleeping while Semiphemeral is running #111, PR Add in-app notice about U2F security keys #123, merged).

Evidence

  • Before: 34 ADRs, essay comments across ~18 source files.
    After: 3 ADRs, short comments; npm run test → 120 files, 1492
    tests passed, "Type Errors: no errors"
    (includes the canonical fixture
    conformance suite, which hard-depends on docs/archive/bluesky/v2/);
    npm run lint clean.

Merge Danger

Door: two-way

Documentation and comments only; everything deleted lives in git history and
the commits are trivially revertible.

Blast Radius: low — agent docs that say "read relevant ADRs" now find
far less to read; the canonical contract and its CI-gated tests are
untouched.

(This was written by an LLM.)

Consolidate 34 ADRs into 4 one-paragraph decisions (shared Bluesky
archive format, credentials, durable jobs/content-addressed storage,
minimal diagnostics), trim the archive contract README to the
normative spec, and strip essay-style comments from the source.
Git history remains the record of the deleted material.
@micahflee
micahflee force-pushed the docs/reduce-archive-documentation branch from f0f1960 to 65f0e82 Compare October 11, 2026 19:56
…s ADR

ADR 0002 now states the credential policy applies to every platform,
with the per-DID Bluesky OAuth session model as the Bluesky-specific
part. ADR 0003 is explicitly Bluesky-scoped. ADR 0004 (minimal
diagnostics) is deleted: true, but true of every platform, so not
worth its own ADR.
@micahflee
micahflee merged commit c45e7ba into main Oct 11, 2026
1 check passed
@micahflee
micahflee deleted the docs/reduce-archive-documentation branch October 11, 2026 20:11
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