docs(readme): lead with what it does and the quickstart; reference moves to docs/ - #72
Merged
Merged
Conversation
…ves to docs/ The top screen is now the one-line pitch, the redaction diagram and a three-line quickstart. The full round-trip capture, audit format, tenant policy, ops endpoints, configuration, deploy and development sections move verbatim to docs/reference.md, docs/deploy.md and docs/development.md, linked from a Reference list. docs/** joins the documentation label.
askalf
enabled auto-merge (squash)
September 22, 2026 22:23
sprayberry-redline
approved these changes
Sep 22, 2026
sprayberry-redline
left a comment
Collaborator
There was a problem hiding this comment.
Deterministic approval — no LLM reviewed this diff.
Classified low-risk: docs-only (4 file(s)).
This repository requires an approving review before auto-merge can proceed, so this
approval exists to satisfy that gate without spending a full Code Reviewer execution
on a diff whose risk is provable from the file list alone. This approval satisfies ONLY
the review requirement — the merge still separately requires green CI, which this sweep
does not and cannot short-circuit.
Anything outside the docs allowlist, any major dependency bump, any non-Dependabot
dependency change, and any unknown diff keep the full reviewer path.
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.
Docs only. The README leads with what cordon does and how to run it, and the reference material moves to
docs/.Top screen: the one-line pitch, the redaction diagram, and a three-line
docker runquickstart with the base-URL change and theX-Redactedheaders as proof. Next come what it catches, how it behaves (fail closed, the three modes, audit, tenant policy, signed releases) and what it does not do.Moved verbatim, nothing deleted:
docs/reference.md: the full captured round trip (both clients, the response headers, what the provider was sent, the audit line), audit format and verification, per-tenant policy, ops endpoints, configuration.docs/deploy.md: compose,deploy.sh, attestation verification, the dario integration link.docs/development.md: running from source and what each test suite proves.All three are linked from a Reference list. README: 169 → 74 lines. Every relative link resolves;
npm run typecheckandnpm testare green.