AFDocs report - low-hanging fixes (#3238)

SharpRake · web-flow · commit dc81ae199831 · 2026-04-13T15:44:58.000-07:00
## Type of change

**Documentation Infrastructure Update**
- Add visually-hidden llms.txt directive blockquote to every page via
baseof.html
- Add compliance and vulnerabilities sections to llms.txt index template

## What should this PR do?

Improve agent-friendliness of the documentation site by fixing two
failing checks from an AFDocs audit.

## Why are we making this change?

An AFDocs scorecard flagged two actionable failures: no page included a
directive pointing agents to llms.txt, and the llms.txt index was
missing the compliance and vulnerabilities content sections. These gaps
reduce discoverability and coverage for AI agents consuming the
documentation.

## What are the acceptance criteria?

- Every page's HTML source contains a blockquote linking to /llms.txt
- The rendered llms.txt includes ## Compliance and ## Vulnerabilities
sections with links to their respective pages
- The blockquote is not visibly rendered on any page (Bootstrap
visually-hidden class)

## How should this PR be tested?

1. Check the preview link and navigate to any doc page — view source and
confirm the visually-hidden blockquote is present near the top of &lt;body&gt;
2. Visit /llms.txt on the preview and confirm the Compliance and
Vulnerabilities sections appear with populated links

---------

Signed-off-by: Mark Drake &lt;mark@chainguard.dev&gt;
diff --git a/layouts/_default/baseof.html b/layouts/_default/baseof.html
@@ -15,6 +15,7 @@
   {{ partial "amplitude.html" . }}
   <body class="{{ .Scratch.Get "class" }}">
     {{ partial "googleTagManagerBody.html" . }}
+    <blockquote class="visually-hidden">For the complete documentation index, see <a href="/llms.txt">llms.txt</a>.</blockquote>
     {{ partial "header/header.html" . }}
     <div class="wrap container-{{ if .Site.Params.options.fullWidth }}fluid{{ else }}xxl{{ end }}" role="document">
       <div class="content">
diff --git a/layouts/index.txt b/layouts/index.txt
@@ -20,6 +20,12 @@
 - [{{ .Title }}]({{ .Permalink | replaceRE "/$" ".md" }}){{ with .Description }}: {{ . }}{{ end }}
 {{ end }}
 
+## Compliance
+
+{{ range where .Site.RegularPages "Section" "compliance" -}}
+- [{{ .Title }}]({{ .Permalink | replaceRE "/$" ".md" }}){{ with .Description }}: {{ . }}{{ end }}
+{{ end }}
+
 ## API Reference
 
 - [Chainguard API (Combined)](https://edu.chainguard.dev/api.json): OpenAPI spec for all Chainguard API versions (JSON)
