Skip to content

docs: say the suite checks attestation field shape, not the attestation - #110

Merged
imran-siddique merged 1 commit into
mainfrom
docs/honest-claims
Sep 14, 2026
Merged

docs: say the suite checks attestation field shape, not the attestation #110
imran-siddique merged 1 commit into
mainfrom
docs/honest-claims

Conversation

@imran-siddique

Copy link
Copy Markdown
Member

The site metadata said the suite checks "that your attestation receipts satisfy the specification ... before shipping them to production", and levels.md called Level 1 "Production TEE-attested records". LIMITATIONS.md says TR-RTE checks the shape of the attestation fields, not the attestation. The llms.txt description, the JSON-LD, the index description, the README heading and both level tables now say what the suite actually checks.

Also in this PR

  • index.md said "eight modules" and its table listed seven. TR-APR is added.
  • The README said "Test suite v0.2" while the package is 0.5.1. It now only states the spec version the suite tracks.
  • site_description and the footer copyright lose their em dashes.
  • docs/levels.md and docs/quickstart.md samples use example-provider and example-model-1.
  • SPONSORS.md names OPAQUE as sponsor without the disclaimer.

Left alone on purpose: test vectors keep their model fields, and the em dashes in module page headings are a separate style pass.

Checked: tests/test_docs_match_the_modules.py passes (6 of 6) in a clean venv with this tree installed editable; mkdocs.yml parses in both its committed form and the deploy's docs_dir rewrite.

Generated with Claude Code

https://claude.ai/code/session_013aK3gVWzNdcM3hZ2o2awK2

The metadata said the suite checks that attestation receipts satisfy the
specification before shipping to production, and levels.md called Level 1
production TEE-attested records. LIMITATIONS.md says TR-RTE checks the shape
of the attestation fields, not the attestation. The metadata, README heading
and both level tables now say what the suite checks.

Also: index.md said eight modules and listed seven; TR-APR is added. The
README said test suite v0.2 while the package is 0.5.1; it now only states
the spec version it tracks. The site description and footer lose their em
dashes, doc samples use a placeholder model, and SPONSORS.md names OPAQUE as
sponsor without the disclaimer.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013aK3gVWzNdcM3hZ2o2awK2
@imran-siddique
imran-siddique requested a review from a team as a code owner September 14, 2026 16:42
@imran-siddique
imran-siddique merged commit d66dd66 into main Sep 14, 2026
7 checks passed
@imran-siddique
imran-siddique deleted the docs/honest-claims branch September 14, 2026 16: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