Repository navigation
ledger: stop naming Pb Notes (#140) - #141
Merged
Merged
Conversation
AGENTS.md now describes a shared event ledger and links to the format spec, so every consumer of this format writes the same bytes. The spec says "the consumer" where it named pagesFold and @pbnotes/files. The lock folder keeps its pbnotes-locks name, with a comment on why: renaming it would let an old and a new build take different locks and append to the same writer directory. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The spec link carried the repo's name. The text now says what the folder is on its own: one folder per writer, LEDGER holds the version. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Pointing to the repo is fine; only the app's name in the text had to go. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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.
Closes #140.
@pbnotes/ledgerno longer names the app that uses it, except for the two places below that are kept on purpose.Changes
AGENTS.md(option 1 from the issue). The text now calls the folder an event ledger that several writers share, and links to the format spec (packages/ledger/multi-writer.mdin this repo) instead of naming the app. It names no consumer, so every consumer of this format version writes the same bytes. The exact-bytes test is updated.AGENTS.md, get the new text (the backfill stays until ledger: stop backfilling AGENTS.md into existing ledgers #106).AGENTS.md, including one with the old Pb Notes text, is left as it is: it is only ever created, never rewritten.pbnotes-locks-${uid}. A comment inlock()now explains why the name is frozen: the lock is all that keeps two processes out of one writer directory. If the name changed, an old build and a new build running at once would take different locks, and both could append to the same directory.multi-writer.md. The spec says "the consumer" where it named@pbnotes/filesandpagesFold, and itsAGENTS.mddescription matches the new text.What the done-when grep still finds
grep -niE 'pb ?notes|pagesFold|@pbnotes/(files|pages)' packages/ledgerstill finds two things besides the package name. Both are intended:github.com/shovon/pbnotes/...in theAGENTS.mdlink. The spec lives in this repo, so its URL has the repo's name in it.pbnotes-locks-inledger.tsandopen-writer.test.ts. This is the frozen lock name.Not covered
multi-writer.mdstill describes the app's focus and refresh behaviour under "Pacing" ("The app keeps the ledger of every project opened this session…"). The grep doesn't catch it and the issue doesn't list it, so I left it alone.Testing
npm test: all workspaces pass (ledger: 41/41).npm run typecheck: clean.🤖 Generated with Claude Code