Restore omitted README CLI and service-surface reference #114

New issue

Closed

opened 2026-09-03 18:01:19 +00:00 by larandar · 0 comments

larandar commented

2026-09-03 18:01:19 +00:00

Owner

In scope

Restore the documented --policy FILE entry point for trying policy parameters before crystallization.
State the served interface (/healthz, /v1/manifest, /v1/evaluate, /v1/audit, and POST /webhook/forgejo) and the resulting reverse-proxy boundary.
Make In scope and Out of scope children of the README perimeter section.

Out of scope

Runtime, policy, Nix, CLI behavior, or endpoint changes.
Reopening or rewriting merged PR #86.

Boundary

Only README.md changes.

Acceptance

The global --policy FILE capability is documented and consistent with src/main.rs and src/policy.rs.
Every served endpoint and its loopback/reverse-proxy boundary is named concisely.
The perimeter heading hierarchy is semantically nested.
rumdl check README.md passes.

Provenance

Specification miss found during review of merged PR #86, which closed #85. This follow-up preserves the no-bounce rule.

## In scope - Restore the documented `--policy FILE` entry point for trying policy parameters before crystallization. - State the served interface (`/healthz`, `/v1/manifest`, `/v1/evaluate`, `/v1/audit`, and `POST /webhook/forgejo`) and the resulting reverse-proxy boundary. - Make `In scope` and `Out of scope` children of the README perimeter section. ## Out of scope - Runtime, policy, Nix, CLI behavior, or endpoint changes. - Reopening or rewriting merged PR #86. ## Boundary Only `README.md` changes. ## Acceptance - The global `--policy FILE` capability is documented and consistent with `src/main.rs` and `src/policy.rs`. - Every served endpoint and its loopback/reverse-proxy boundary is named concisely. - The perimeter heading hierarchy is semantically nested. - `rumdl check README.md` passes. ## Provenance Specification miss found during review of merged PR #86, which closed #85. This follow-up preserves the no-bounce rule.

larandar added the

Kind/Documentation

label

2026-09-03 18:01:28 +00:00

larandar referenced this issue from a pull request that will close it,

2026-09-03 18:11:31 +00:00

docs: restore README CLI and service surface reference #115

larandar closed this issue

2026-09-03 22:42:15 +00:00