docs(readme): the manual, with every stage drawn - #5
Merged
Merged
Conversation
This was referenced Sep 10, 2026
jshvn
added a commit
to katoptra/ctan
that referenced
this pull request
Sep 10, 2026
#30) ## 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, Reference. Everything the mirrors share links to katoptra/lib's README (katoptra/lib#5) rather than being repeated: the vault, the toolbox verbs, the workflows, the state. - `CONTRIBUTING.md` follows lib's pattern: the org's rules apply, plus what this repository adds. - `SECURITY.md` is the guarantee list and the reporting link. - `CLAUDE.md` drops the restatement of what the mirror owns and the secrets bullet; it keeps the must-knows and the hazards and points at the README. - `op.env` and `docs/reference.md` no longer name the org's vault or dispatcher; a fork reads the same sentence and it is true. No verb changes; `render.txt` is untouched. ## Storage and operations None. ## Test plan - [ ] `task check` passes (the `check` workflow) - [ ] The rendered README's diagram draws and its lib links resolve once katoptra/lib#5 merges
jshvn
added a commit
to katoptra/tlnet
that referenced
this pull request
Sep 10, 2026
#6) ## 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.md` follows lib's pattern: the org's rules apply, plus what this repository adds. - `SECURITY.md` is 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 overlapping `tlmgr` run sees the previous tlpdb rather than checksum errors. - `CLAUDE.md` drops the restatement of what the mirror owns and the secrets bullet; it keeps the must-knows and points at the README. - `op.env` no longer names the org's vault. `site/index.html` is untouched; it repeats the "How to use" section, which did not change in substance. No verb changes; `render.txt` is untouched. ## Storage and operations None. ## Test plan - [ ] `task check` passes (the `check` workflow) - [ ] The rendered README's diagram draws and its lib links resolve once katoptra/lib#5 merges
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
lib's README becomes the one place the system is explained: the system in one picture, the layers, the run sequence, the toolbox, both engines with their pipelines drawn, the state and the signed-subtree checks, the Proton session lifecycle, Secrets, Storage, Monitoring, the images and the lock, the reusable workflows step by step, the three mirror shapes, Changing it, and Recreating it from nothing. Twelve mermaid diagrams. The sample workflow pins move from v1.0.2 to v2.0.0 and the sample Taskfiles use
op.envrather thanPASS.CLAUDE.mdis trimmed to the hazards the README does not carry and points at the README.sync.yml's header comment names "an external scheduler" instead of the org's dispatcher.Nothing under
toolbox.yml,engines/,docker/or the workflows' steps changes. The consumer READMEs (one PR per mirror) link the headings#secrets,#storage,#the-rsync-engineand#the-proton-enginehere.Storage and operations
None.
Test plan
task checkis unaffected: no verb changed