Skip to main content

Documentation Index

Fetch the complete documentation index at: https://na-36-merge-docs-v2-dev-draft-into-docs-v2-clean-20260525.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Discoverability Pipeline

Gate: P4 (post-merge auto-commit) + P3 validators on PR Trigger: Push to docs-v2 branch after merge Workflows: generator-discoverability-generate-*.yml + validator-discoverability-check-*.yml

What happens after a page merge

What happens on PR (validation)


Generators

ScriptOutputConsumerRefresh
generate-llms-files.jsllms.txtClaude, ChatGPT, PerplexityPost-merge (P4)
generate-ai-sitemap.jssitemap-ai.xmlAI crawlersPost-merge (P4)
generate-glossary-companions.jsv2/**/*-data.jsonFrontend tooltipsPost-merge (P4)
generate-docs-index.jssnippets/data/docs-index.jsonSite searchPost-merge (P4)
generate-pages-index.jsdocs-guide/catalog/pages-catalog.mdxInternal referenceManual
generate-og-images.jssnippets/assets/media/og-images/*.pngSocial sharingManual (requires Puppeteer)

Validators (P3 — advisory)

ScriptWhat it checks
verify-llms-files.js (check-llms-files)llms.txt exists and matches what the generator would produce
verify-ai-sitemap.js (check-ai-sitemap)sitemap-ai.xml is valid and current
check-companion-manifest.js (check-companions)Companion JSON files exist for all glossary terms
check-docs-index.jsdocs-index.json matches current page inventory

Remediators

ScriptWhat it fixes
generate-seo.jsRegenerates SEO metadata (descriptions, keywords)

Gaps

  • Validators check existence only: No content quality validation of llms.txt or sitemap-ai.xml (e.g., completeness, broken entries)
  • OG images manual only: generate-og-images.js not in CI — requires Puppeteer, runs locally. Fallback OG is generic
  • No auto-update on page rename: llms.txt and sitemap-ai.xml have no mechanism to detect renames between generator runs. Stale entries persist until the next full regeneration
Last modified on May 26, 2026