Skip to content

docs(readme): lead with what it does and the quickstart; reference moves to docs/ - #72

Merged
askalf merged 1 commit into
mainfrom
docs/readme-lead-with-the-proof
Sep 22, 2026
Merged

askalf merged 1 commit into
mainfrom
docs/readme-lead-with-the-proof

Conversation

@askalf

@askalf askalf commented Sep 22, 2026 •

Copy link
Copy Markdown
Owner

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 run quickstart with the base-URL change and the X-Redacted headers 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 typecheck and npm test are green.

…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.
@github-actions github-actions Bot added documentation Improvements or additions to documentation size/L 200-799 hand-written lines labels Sep 22, 2026
@askalf
askalf enabled auto-merge (squash) September 22, 2026 22:23

@sprayberry-redline sprayberry-redline left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@askalf
askalf merged commit f231950 into main Sep 22, 2026
5 checks passed
@askalf
askalf deleted the docs/readme-lead-with-the-proof branch September 22, 2026 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/L 200-799 hand-written lines

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants