Skip to content

docs: readme#836

Merged
jithinraj merged 4 commits into
mainfrom
docs/readme-signed-action-records-topfold
Jun 11, 2026
Merged

docs: readme#836
jithinraj merged 4 commits into
mainfrom
docs/readme-signed-action-records-topfold

Conversation

@jithinraj

@jithinraj jithinraj commented Jun 11, 2026

Copy link
Copy Markdown
Member

Summary

Top-fold clarity improvement plus a final README polish. The headline uses "signed action records" (the developer-clear hook); the next paragraph defines the formal artifact as "portable signed interaction records" (the protocol-grade term covering decisions, observations, denials, payment events, provisioning events, gateway reports, and bundles). Present-tense framing; the canonical line "Record locally. Verify across boundaries." is unchanged.

Scope (README.md only)

  • New opening paragraphs (headline, present-tense context, formal definition).
  • Quickstart fix: the failure object exposes code and message (there is no reason field); the example no longer throws dead fallback text.
  • The MCP gateway records recipe is now discoverable: a Use-cases row, a Try-it entry running the example demo and tamper checks, and a start link in the Choose-your-path gateway row.
  • Badges, the "What PEAC records" table content, boundary language, and all command conventions (npm install for libraries, pnpm dlx for one-off CLI, npx -y for the MCP server) are unchanged.
  • No protocol behavior changes; no package, version, or schema changes.

Validation

  • prettier clean; git diff --check clean; tooling suite 955 passed (37 files); public-artifact and planning-leak scanners pass.
  • Both documented demo commands verified end-to-end from the workspace root.

@jithinraj jithinraj changed the title docs(readme): clarify PEAC as signed action records docs: readme Jun 11, 2026
@jithinraj jithinraj merged commit b1a5d38 into main Jun 11, 2026
25 checks passed
@jithinraj jithinraj deleted the docs/readme-signed-action-records-topfold branch June 11, 2026 10:47
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