Repository navigation
docs: refresh documentation after the migration - #3
Merged
Merged
Conversation
- Root README: purpose, package table with npm links, old package names, related repositories, requirements (Node 24, pnpm via corepack), development commands from package.json, CI, releases, license. - Package READMEs: add entry points, install notes; check every example and export against src; fix stale short names (storage, content-store, merge-core, files-sync); document defaults (chunk threshold, CDC params, text merge limit, verify mode); fix the remote transfer example (undefined `drain`) and the merge example output shape; drop the claim that vcs-commands uses webrun-merge. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
- Package READMEs now follow What it is / Why it exists / How to use / Examples / Internals / License, with the reasoning behind each design choice and the failure modes in the words the code uses. - Root README is an operating manual: layout, how to work on it, why it is shaped this way, what will surprise you (typecheck needs a build), reference. - Remove links to other repositories and any history (old names). - Examples re-run against the built packages. The files-sync example now uses files of different sizes: equal size and mtime count as unchanged. - Document current behaviour found while checking: chunkTransfer cannot use a remoteStore proxy as `remote`, and does not verify chunks; transfer verifies only when hashContent is passed; the checkpoint only adds a `resumed` event; verification modes collapse to size or hash. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U
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.
Refreshes the documentation to match the current code.
package.json), why it is shaped this way, what will surprise you (pnpm typecheckneedspnpm buildfirst), and a reference of commands, CI checks and files.src/. The examples were run against the built packages.drain; the files-sync copy example claimed an update that does not happen (both files had the same size and mtime); the merge README claimed a consumer that does not use it.chunkTransferfails with aremoteStoreproxy asremote(remote proxy does not support "read"), and it does not verify chunks.transferverifies chunks only whenhashContentis passed.TransferCheckpointonly adds aresumedevent. Resuming works by re-negotiating.No code, config or lockfile changes.
🤖 Generated with Claude Code
https://claude.ai/code/session_01DAiZN6XrTAdQpNN3eXEz2U