docs: rewrite README + CLAUDE.md as a fresh codebase review #33

Merged
starsetbyte merged 1 commit from docs/refresh-readme-claude into main 2026-06-21 20:32:05 +00:00
Owner

Summary

  • Rewrote both README.md and CLAUDE.md from scratch as if reading the project cold — the README still advertised "Phase 5 complete" while OAuth 2.0 DPoP, search & discovery, interactions, notifications, and home-feed modernization have all landed on main.
  • Factual corrections against the actual tree: OAuth/DPoP is now the real auth story (the old "app-password only / PDS hardcoded to bsky.social" limitation is resolved for OAuth users); moderation correctly flagged as on-branch (feat/moderation, unmerged); DB schema bumped to v8; unit-test count updated to 215; version 0.2.0 / SDK 29–35; CI clarified as running on the Forgejo instance runner (no workflow file is tracked in-repo).
  • Gave both files a consistent voice and tightened the engineering notes (auth/DPoP stack, the issue #3 timeline bug, facet byte-offset invariants, PostEntity composite key, per-tab ViewModel scoping) so future work doesn't re-derive them.

Files

  • README.md — full rewrite: refreshed status table, the 85K-post problem, architecture overview, accurate tech stack.
  • CLAUDE.md — full rewrite: updated implementation-status table, expanded auth section for the DPoP stack, known-gaps list reconciled with shipped code.

Test plan

  • Skim both rendered docs on the Forgejo web view for formatting.
  • Confirm the status table matches what's actually on main (OAuth merged, moderation on branch).
  • Sanity-check that no internal links (docs/MVP_IMPLEMENTATION_PLAN.md, CHANGELOG.md) broke.

💘 Generated with Crush

## Summary - Rewrote both `README.md` and `CLAUDE.md` from scratch as if reading the project cold — the README still advertised "Phase 5 complete" while OAuth 2.0 DPoP, search & discovery, interactions, notifications, and home-feed modernization have all landed on `main`. - Factual corrections against the actual tree: OAuth/DPoP is now the real auth story (the old "app-password only / PDS hardcoded to bsky.social" limitation is resolved for OAuth users); moderation correctly flagged as on-branch (`feat/moderation`, unmerged); DB schema bumped to v8; unit-test count updated to 215; version `0.2.0` / SDK 29–35; CI clarified as running on the Forgejo instance runner (no workflow file is tracked in-repo). - Gave both files a consistent voice and tightened the engineering notes (auth/DPoP stack, the issue #3 timeline bug, facet byte-offset invariants, `PostEntity` composite key, per-tab ViewModel scoping) so future work doesn't re-derive them. ## Files - `README.md` — full rewrite: refreshed status table, the 85K-post problem, architecture overview, accurate tech stack. - `CLAUDE.md` — full rewrite: updated implementation-status table, expanded auth section for the DPoP stack, known-gaps list reconciled with shipped code. ## Test plan - [ ] Skim both rendered docs on the Forgejo web view for formatting. - [ ] Confirm the status table matches what's actually on `main` (OAuth merged, moderation on branch). - [ ] Sanity-check that no internal links (`docs/MVP_IMPLEMENTATION_PLAN.md`, `CHANGELOG.md`) broke. 💘 Generated with Crush
docs: rewrite README + CLAUDE.md as a fresh codebase review
All checks were successful
peregrine-ci / assembleDebug Build succeeded (6s)
4ee593975a
Refresh both project docs against the actual state of main: the old README
still claimed "Phase 5 complete" while OAuth 2.0 DPoP, search & discovery,
interactions, notifications, and home-feed modernization have all landed.
Rewrote both from scratch as if reading the project cold, with a consistent
voice. Key factual updates: OAuth/DPoP is now the real auth story (not
"app password only, PDS hardcoded"), moderation correctly marked as
on-branch/unmerged, DB schema bumped to v8, 215 unit tests, v0.2.0/SDK 35,
and the in-repo CI workflow path corrected (CI runs on the Forgejo instance,
no workflow file is tracked).

💘 Generated with Crush
Sign in to join this conversation.
No description provided.