docs: public surfaces tell the truth — llms.txt, README positioning, ARCHITECTURE.md - #28
Open
Danny-Devs wants to merge 1 commit into
Open
docs: public surfaces tell the truth — llms.txt, README positioning, ARCHITECTURE.md#28Danny-Devs wants to merge 1 commit into
Danny-Devs wants to merge 1 commit into
Conversation
…w ARCHITECTURE.md llms.txt said 'pre-release, unpublished' five weeks after colada-db@0.1.0 shipped; it now states the publish, the positioning sentence, and that the sync layer exists on main and is deliberately unexported. README carries the one positioning line that survives inspection — state stays on the device, agents get a scoped, gated, attributed window, never the keys — and its sync bullet moves from 'specified, not shipped' to 'built on main, not yet in the published package, 0.2.0 after an adversarial review'. ARCHITECTURE.md is the map: five headings, named files and types, and the invariants stated as absences (reads never await · engines never serve reads · zero write tools · unlisted types do not exist · evict has no authority over durability). Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01C4XCwFzDxpG7fuseukFQ6j
|
Warning Review limit reachedNext included review available in 59 minutes. View limit detailsLimit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. Review configuration: ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (3)
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 |
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
1 participant
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.
What changed
llms.txtsaid "pre-release, unpublished" —colada-db@0.1.0has been on npm since 2026-08-02. Now states the publish, the positioning sentence, and that the sync layer exists onmainand is deliberately unexported (with the file names).README.mdgains the one positioning line every clause of which is shipped code: your app's state stays on the device; agents get a scoped, gated, attributed window into it — never the keys. The sync bullet moves from specified, not shipped to built onmain, not in the published package, 0.2.0 after an adversarial review. Links the new map.ARCHITECTURE.md(new) — the map, matklad-short: five headings, files/types/functions named, never line numbers, and the invariants that are easiest to miss because they are absences.Why
Three canonical surfaces asserted the repo's own state and none was updated when it went public. One fact, three asserters. This PR makes them agree with npm and with
main.Verify
Prose only — no code, no gates touched.
pnpm check:publish-surface/check:api-report/check:pack-manifestunaffected (README is in the pack manifest already; content changes do not alter the file list).🤖 Generated with Claude Code
https://claude.ai/code/session_01C4XCwFzDxpG7fuseukFQ6j