Skip to content

docs: plain-language pass on the docs site and README - #479

Merged
imran-siddique merged 3 commits into
mainfrom
docs/plain-language
Oct 8, 2026
Merged

imran-siddique merged 3 commits into
mainfrom
docs/plain-language

Conversation

@imran-siddique

Copy link
Copy Markdown
Member

The site, README, FAQ and docs pages are rewritten in plain words, and each spec file gets one plain lead-in with the normative text unchanged. The conformance site under conformance/ gets the same pass, ported from the archived trace-tests repository, adding TR-APR to the per-level module lists. ROADMAP now cites conformance 0.6.2, the quickstart caveat reflects PyPI agentrust-trace 0.11.0, and the quickstart heading matches trust-levels (hardware evidence is Level 1, transparency Level 2). Both mkdocs sites build with --strict; conformance tests: 706 passed.

Part of the plain-language pass across AgenTrust, alongside agentrust-io/agentrust-io.github.io#97.

🤖 Generated with Claude Code

imran-siddique and others added 3 commits October 7, 2026 14:16
Every published prose page now opens with what it is for and who needs it,
explains terms at first use, and moves deep detail into Technical detail
blocks. Spec and RFC files get a plain lead-in only. ROADMAP conformance
suite 0.5.1 -> 0.6.2 (conformance/pyproject.toml, release conformance-v0.6.2);
quickstart notes PyPI agentrust-trace 0.11.0 no longer requires transparency.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Hardware evidence is Level 1 and transparency is Level 2 (trust-levels.md).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Ported from the archived trace-tests repository. Adds TR-APR to the
per-level module lists (runner._LEVEL_MODULES), the Appraisal row in the
README table, and removes the CI guide's claims that the suite reads
CMCP_DEV_MODE or supports Python 3.10 (pyproject requires 3.11).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@imran-siddique
imran-siddique requested review from a team, lywinged and rajnisht7 as code owners October 7, 2026 21:23

@Qiang-Xu Qiang-Xu 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.

Looks okay to me.

Comment thread LIMITATIONS.md

**TEE side-channel attacks**
Hardware attestation proves the TRACE signing key and policy engine were measured in silicon before execution. It does not protect against side-channel attacks (cache timing, power analysis) targeting the TEE itself. TEE-level side-channel defense is the responsibility of the TEE platform vendor.
A TEE (trusted execution environment) is a sealed area of a processor that even the machine's operator cannot look into. Hardware attestation, the processor's signed report of what is running inside it, proves the TRACE signing key and policy engine were measured in silicon before execution. It does not protect against side-channel attacks (cache timing, power analysis) targeting the TEE itself. TEE-level side-channel defense is the responsibility of the TEE platform vendor.

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.

Hmm, "a sealed area of a processor" might not be the best way to describe it but it can give the audience some high level idea about the technology itself.

@imran-siddique
imran-siddique merged commit 1468629 into main Oct 8, 2026
16 checks passed
@imran-siddique
imran-siddique deleted the docs/plain-language branch October 8, 2026 00:42
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.

2 participants