Skip to content

docs: rewrite the README for the codebase as it is now - #390

Merged
PastaPastaPasta merged 1 commit into
stagingfrom
docs/readme
Sep 8, 2026
Merged

docs: rewrite the README for the codebase as it is now#390
PastaPastaPasta merged 1 commit into
stagingfrom
docs/readme

Conversation

@PastaPastaPasta

Copy link
Copy Markdown
Owner

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:

  • what the app does, in eight bullets by area
  • how to run it and the full script table (incl. build:testing, build:devnet, lint:dead, test:e2e) and what CI enforces
  • the stack, correctly
  • the directory layout at the granularity that stays true (one line per area, not per file)
  • the four things a contributor has to understand: contract topology, $ownerId ownership, the unconfirmed-write gate, and storage scoping across sub-path deployments

Every 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

  • Docs only; no code changes.

🤖 Generated with Claude Code

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.
@coderabbitai

coderabbitai Bot commented Sep 8, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Team

Run ID: 4a2376e4-5fea-4547-b82c-0f7246e9cfcc

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@PastaPastaPasta
PastaPastaPasta merged commit 52f935a into staging Sep 8, 2026
8 of 9 checks passed
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