docs(readme): the consumer shape; lib is the manual for what is shared - #6
Merged
Merged
Conversation
2 tasks
jshvn
added a commit
that referenced
this pull request
Sep 13, 2026
## What katoptra/lib v2.1.1 (lib PR #6) makes the engine's `retry` pass rsync exit 23, the code a dangling symlink under `-L` returns with the listing otherwise intact. The `v2` include moved with the tag, so `task check` renders three lines differently. This is `task render-update`, nothing else. ## Storage and operations None. ## Test plan - [x] `task --download render-update` locally; the diff is the three renderings of the retry case line - [ ] CI green
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 changes
The README takes the consumer shape used across the org: the lede, How to use, How it works (the pipeline drawn, this mirror's verbs dashed), Want your own? (fork, storage, secrets, the zone, prove it), Operating it with a short runbook, Reference. Everything the mirrors share links to katoptra/lib's README (katoptra/lib#5).
CONTRIBUTING.mdfollows lib's pattern: the org's rules apply, plus what this repository adds.SECURITY.mdis the guarantee list and the reporting link. Its atomicity paragraph now says what the engine does: the tlpdb lands last, after every container it names, so an overlappingtlmgrrun sees the previous tlpdb rather than checksum errors.CLAUDE.mddrops the restatement of what the mirror owns and the secrets bullet; it keeps the must-knows and points at the README.op.envno longer names the org's vault.site/index.htmlis untouched; it repeats the "How to use" section, which did not change in substance. No verb changes;render.txtis untouched.Storage and operations
None.
Test plan
task checkpasses (thecheckworkflow)