Skip to content

docs(readme): the consumer shape, a How to use, and a first CLAUDE.md - #2

Merged
jshvn merged 1 commit into
mainfrom
josh/readme-shape
Sep 10, 2026
Merged

jshvn merged 1 commit into
mainfrom
josh/readme-shape

Conversation

@jshvn

@jshvn jshvn commented Sep 10, 2026

Copy link
Copy Markdown
Member

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.

  • A first 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.env no longer names the org's vault.

No verb changes; render.txt is untouched.

Storage and operations

None.

Test plan

@jshvn
jshvn merged commit bf77205 into main Sep 10, 2026
1 check passed
@jshvn
jshvn deleted the josh/readme-shape branch September 10, 2026 07:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant