Skip to content

docs: expand levels page with concrete record examples per level#26

Merged
imran-siddique merged 2 commits into
mainfrom
docs/levels-with-examples
Jun 21, 2026
Merged

docs: expand levels page with concrete record examples per level#26
imran-siddique merged 2 commits into
mainfrom
docs/levels-with-examples

Conversation

@imran-siddique

Copy link
Copy Markdown
Contributor

Summary

Replaces the 100-word levels.md stub with full per-level sections:

  • Level 0: minimum conformant record JSON, modules tested, common failure causes
  • Level 1: minimum conformant record JSON with non-zero measurement and affirming appraisal, delta failures over Level 0
  • Level 2: additional tool_transcript and anchor fields, delta failures over Level 1
  • Related links to error-codes, test modules, and trace-spec trust levels page

Test plan

  • MkDocs builds without warnings
  • JSON snippets are syntactically valid
  • Error code references (TR-ENV-001, TR-SIG-003, etc.) match entries in error-codes.md

Replaces the 100-word stub with full per-level sections, each
containing a minimum conformant record snippet, the list of modules
tested, and the most common failure causes at that level. Adds a
Related section linking to error-codes, modules, and the trace-spec
trust levels page.

Signed-off-by: Imran Siddique <imran.siddique@opaque.co>
Every TR-* error now includes a concrete fix instruction alongside the
description. Closes the gap where error-codes.md described what was
wrong but not how to correct it.

Signed-off-by: Imran Siddique <imran.siddique@opaque.co>
@imran-siddique imran-siddique merged commit 03e8432 into main Jun 21, 2026
@imran-siddique imran-siddique deleted the docs/levels-with-examples branch June 21, 2026 21:38
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