docs(readme): the consumer shape, a How to use, and a first CLAUDE.md - #3
Merged
Merged
Conversation
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.
What changes
The README takes the consumer shape used across the org and comes down from 515 lines: the lede with the provenance note, How to use (new: where the files are, what an edit and a delete become), How it works (the pipeline drawn, every migrator step dashed, the step table cut to a sentence or two each, the evidence paragraph kept), Want your own? (fork, storage, secrets, the Dropbox app and the session, prove it and seed), Operating it with the runbook trimmed to its entries, Reference (the TOML table, what sits where). The Proton session commands, the vault setup and what the reusable workflow does are linked to katoptra/lib's README (katoptra/lib#5) rather than repeated. Emoji headings go.
CLAUDE.md: the must-knows (plan by default, a missing state beside history is refused, the listing floor, checkpoint last, the session is this mirror's own, flags after the double dash) and how to verify a change.op.envno longer names the org's vault.Dropped from the README on purpose: the repository-layout tree (what
lssays), the toolbox verb list (lib's), the paragraph on whatcheck.ymlruns (it is one job, not the reusable workflow plus a second job, as the old text said). No code changes;render.txtis untouched.Storage and operations
None.
Test plan
task check,task testandtask lintpass (thecheckworkflow)