diff --git a/docs/assets/og.png b/docs/assets/og.png new file mode 100644 index 0000000..f54df69 Binary files /dev/null and b/docs/assets/og.png differ diff --git a/mkdocs.yml b/mkdocs.yml index cba4fc9..b724232 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -25,6 +25,7 @@ exclude_docs: | theme: name: material + custom_dir: overrides font: false palette: - scheme: slate @@ -59,6 +60,32 @@ theme: plugins: - search: lang: en + - llmstxt: + full_output: llms-full.txt + markdown_description: >- + TRACE Tests is the conformance suite for TRACE (Trust Runtime + Attestation and Compliance Evidence), the AgenTrust open standard for + signed, hardware-attested AI agent governance records. Use it to check + that your attestation receipts satisfy the specification, at each + conformance level, before shipping them to production. + sections: + Getting started: + - README.md + - docs/quickstart.md + - docs/levels.md + Test modules: + - docs/modules.md + - docs/modules/tr-env.md + - docs/modules/tr-sig.md + - docs/modules/tr-rte.md + - docs/modules/tr-pol.md + - docs/modules/tr-txn.md + - docs/modules/tr-anc.md + - docs/modules/tr-sca.md + Reference: + - docs/error-codes.md + - docs/tutorials/writing-conformance-tests.md + - docs/tutorials/ci-integration.md - minify: minify_html: true - mkdocstrings: diff --git a/overrides/main.html b/overrides/main.html new file mode 100644 index 0000000..42c171a --- /dev/null +++ b/overrides/main.html @@ -0,0 +1,87 @@ +{% extends "base.html" %} + +{# + SEO and AEO head additions for the TRACE conformance suite. + + 1. The homepage is overridden. Material falls back to site_name when a + page has no front-matter title, which left the homepage titled "TRACE + Tests". Front matter is not an option: docs_dir is the repository root, so + README.md is also the GitHub landing page and YAML would render as noise + there. + + 2. Open Graph and Twitter meta, so links produce a card instead of a bare URL, + plus JSON-LD so answer engines can model what this suite is. + + Asset paths derive from config.site_url. Do not hardcode them: assets are + served under /docs/assets/ here because docs_dir is the repository root and + CI copies docs/ into the build directory. That differs between sibling + repositories, and a hardcoded path is how cMCP shipped a broken card. +#} + +{% block htmltitle %} + {% if page and page.is_homepage %} + <title>Verify your TRACE implementation - {{ config.site_name }} + {% else %} + {{ super() }} + {% endif %} +{% endblock %} + +{% block extrahead %} + {{ super() }} + {% set page_desc = page.meta.description if page and page.meta and page.meta.description else config.site_description %} + {% set page_url = page.canonical_url if page and page.canonical_url else config.site_url %} + {% set og_image = config.site_url ~ 'docs/assets/og.png' %} + {% set social_title = 'Verify your TRACE implementation' %} + + + + + + + + + + + + + + + + + + +{% endblock %} diff --git a/requirements-docs.txt b/requirements-docs.txt index 1846e39..2bab9f8 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -4,3 +4,4 @@ mkdocs-minify-plugin>=0.8 pymdown-extensions>=11.0.1 mkdocstrings[python]>=1.0.6 griffe>=2.1.0 +mkdocs-llmstxt>=0.5,<1.0