docs: rewrite the README for the codebase as it is now - #390
Merged
Conversation
The old one listed every route and every file, half of which had been renamed or deleted, and named Headless UI and Lucide as the UI stack. The new one says what the app does, how to run and check it, how the tree is laid out, and the four things a contributor has to know: contract topology, document ownership, the unconfirmed-write gate, and storage scoping.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The README was a 396-line inventory: every route in a table, every file in a tree, a feature list with one bullet per menu item, and a tech-stack table that still named Headless UI and Lucide. Much of the tree was stale after this series (hooks and services renamed or removed, new
lib/modules absent).The new README (98 lines) covers:
build:testing,build:devnet,lint:dead,test:e2e) and what CI enforces$ownerIdownership, the unconfirmed-write gate, and storage scoping across sub-path deploymentsEvery claim was checked against the code (passkey unlock in
lib/webauthn, key-exchange login, YAPP token constants, XChaCha20 in the private-feed crypto,BLOG_CHUNK_SIZE,deletesAreTombstones,lib/unconfirmed-writes.ts,STORAGE_SCOPE).Part of the anti-slop cleanup series (after #370–#389).
Test plan
🤖 Generated with Claude Code