docs: add frontmatter, add json output and search extensions, for improving SEO

[miyoungc]

• Search example
• Metadata generation example

Summary

• Add structured YAML frontmatter to all 18 documentation pages in docs/. Each page now includes title (with page and nav fields), description, topics, tags, and a content block with type, difficulty, and audience. Five pages that already had frontmatter were normalized to a consistent format (removed quotes, inline arrays, and the keywords field).
• Add the json_output and search_assets Sphinx extensions (ported from NeMo Guardrails) to docs/_ext/. The json_output extension generates a parallel JSON file for every page at build time, containing frontmatter metadata, extracted content, headings, and keywords for downstream search and LLM consumption. The search_assets extension provides an enhanced search page with faceted filtering by topic, content type, and audience.

Changes

Area	What changed
Frontmatter	Added to 13 files, normalized on 5 existing files
docs/_ext/json_output/	New extension — generates per-page JSON output alongside HTML
docs/_ext/search_assets/	New extension — enhanced search page with filters, keyboard nav, bundled JS/CSS
docs/conf.py	Registered both extensions, added _ext/** to exclude_patterns, added json_output_settings

Test plan

• Run sphinx-build and verify the HTML build succeeds with no new warnings.
• Confirm JSON files are generated in _build/html/ alongside HTML pages.
• Spot-check frontmatter on a few pages (e.g. about/overview.md, reference/cli.md) for correct title, description, topics, tags, and content fields.
• Verify the search page renders with the enhanced UI (filters, input, result cards).

[github-actions]

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-11 01:05 UTC