docs(readme): the consumer shape, a How to use, and a first CLAUDE.md - #2
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 (new: how to restore a bundle, where the history and the trash are), How it works (the proton engine's pipeline drawn, this mirror's hooks dashed), Want your own? (fork, storage, secrets, the tokens and the session, prove it), Operating it with a short runbook, Reference. The Proton session commands, the vault setup and the reusable workflow's behaviour are linked to katoptra/lib's README (katoptra/lib#5) rather than repeated. Emoji headings go, as none of the other repositories have them.
CLAUDE.md: the must-knows (reproducible bundles, one token per owner, the session is this mirror's own, public logs) and how to verify a change.op.envno longer names the org's vault.No verb changes;
render.txtis untouched.Storage and operations
None.
Test plan
task checkandtask run -- task offlinepass (thecheckworkflow)