Repository navigation
docs: add Trust Levels, Glossary, Platforms index; fix quickstart - #56
Merged
Merged
Conversation
- Add docs/trust-levels.md: Level 0/1/2 definitions, minimum required fields per level, decision table, and relationships to platforms and test suite - Add docs/glossary.md: definitions for Trust Record, Trust Level, Appraisal, Conformance, EAT, RATS, SCITT, cnf/JWK, RIM, SPIFFE, Transparency, GatewayClaim, JCS - Add docs/platforms/index.md: overview of supported TEE platforms, platform table, and how Level 1 verification works - Update docs/quickstart.md: add standalone sign_record() example before the AGT section so users can produce a Level 0 record without any external framework dependency - Update mkdocs.yml: add Trust Levels, Glossary, and Platforms overview to nav; remove supernav.js Signed-off-by: Imran Siddique <imran.siddique@opaque.co>
5 tasks done
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
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.
Summary
docs/trust-levels.md): defines Level 0/1/2 in one place — what each level proves, what it does not prove, minimum required fields at each level, and a decision table for choosing a level. Closes the audit gap where these levels appeared throughout the docs but were never defined on a single page.docs/glossary.md): defines Trust Record, Trust Level, Appraisal, Conformance, EAT, RATS, SCITT, cnf/JWK, RIM, SPIFFE, Transparency, GatewayClaim, JCS.docs/platforms/index.md): overview page for the Platforms nav section. Lists all four TEE platforms, theirruntime.platformvalues, and explains how Level 1 verification works. Previously the Platforms nav had no overview entry.sign_record()example before the AGTgovern()example so the quickstart is usable without installing AGT.mkdocs.yml(missed in the earlier theme-alignment PR).Test plan
mkdocs build --strict)