docs(readme): the consumer shape; lib is the manual for what is shared - #30
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: 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.mdfollows lib's pattern: the org's rules apply, plus what this repository adds.SECURITY.mdis the guarantee list and the reporting link.CLAUDE.mddrops 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.envanddocs/reference.mdno longer name the org's vault or dispatcher; a fork reads the same sentence and it is true.No verb changes;
render.txtis untouched.Storage and operations
None.
Test plan
task checkpasses (thecheckworkflow)