Repository navigation
docs: plain-language pass on the docs site and README - #233
Merged
Merged
Conversation
Every docs page and the README now open with a plain statement of what the page is for and who needs it; spec pages get lead-ins only, with normative text untouched. Get-started, guides and the landing page are rewritten in ordinary words, with denial-record ordering and the verify-dag migration notes moved into Technical detail blocks. Refreshed facts: release 0.4.0 (PyPI ca2a-runtime), collector runs on silicon 2026-08-24 and the 2026-09-17 mutual SNP run (docs/hardware-validation.md, docs/mutual-hardware-acceptance.md). Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
imran-siddique
requested review from
a team,
carloshvp and
zohebk8s
as code owners
October 7, 2026 21:23
|
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Qiang-Xu
approved these changes
Oct 7, 2026
Qiang-Xu
left a comment
Qiang-Xu
left a comment
Collaborator
There was a problem hiding this comment.
Looks good to me in general.
| @@ -1,4 +1,6 @@ | |||
| # Peer Attestation | |||
|
|
|||
| Attestation is a report signed by the processor that says what software a machine is running. This page specifies how a cA2A agent produces such a report for TPM, AMD SEV-SNP and Intel TDX hardware, ties its encryption key to it, and how the other side checks it. It is for implementers and security reviewers; for a plain overview read [How It Works](../concepts.md). | |||
Collaborator
There was a problem hiding this comment.
Maybe implementers -> developers?
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
3 participants
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.
Home, quickstart, concepts, configuration, LIMITATIONS, ROADMAP and the tutorials are rewritten in plain words; SPEC.md and the 18 spec pages get plain lead-ins only. Version references move from 0.2 to ca2a-runtime 0.4.0, and ROADMAP now records the 2026-08-24 GCP hardware runs and the 2026-09-17 same-operator mutual SNP run, with the cross-operator case still open. mkdocs build --strict passes, as do the quickstart, documented-experiments and release-artifact tests.
Part of the plain-language pass across AgenTrust, alongside agentrust-io/agentrust-io.github.io#97.
🤖 Generated with Claude Code