#980

fix(docs): site-wide llms.txt omits Monty documentation indexes

Opencoygeekopened 24d ago

Summary

The site-wide documentation index omits Monty even though the documentation homepage includes Monty and its library-specific llms.txt and llms-full.txt are available. An agent following the advertised "All docs" entry point cannot discover Monty's documentation indexes through that file.

Runtime or environment

The live Pydantic documentation site was checked on 2026-10-06. The Monty repository's current main and latest published release v1.1.0 both point to commit 591527397445bf734873252d1ee20c1b6308fe7f. The live site's deployed revision is unknown. The site-wide index returned HTTP 200 with 6,250 bytes and SHA256 c033e04474147503089f055d98eddd6c042a74eff46f81248fc352caab9f3b57.

Steps to reproduce

Run the following read-only commands against the live site. These checks were executed with the user agent shown.

curl -fsSL -A 'Mozilla/5.0' https://pydantic.dev/docs/llms.txt -o docs-llms.txt
python3 - <<'PYTHON'
from pathlib import Path
text = Path('docs-llms.txt').read_text()
print('Mentions Monty:', 'monty' in text.lower())
print('Monty index link:', '/docs/monty/llms.txt' in text)
print('Monty full index link:', '/docs/monty/llms-full.txt' in text)
PYTHON
curl -sSL -A 'Mozilla/5.0' -o /dev/null -w '%{http_code}\n' https://pydantic.dev/docs/monty/llms.txt
curl -sSL -A 'Mozilla/5.0' -o /dev/null -w '%{http_code}\n' https://pydantic.dev/docs/monty/llms-full.txt

Compare the documentation homepage and the "Documentation indexes" section of the root site index with the downloaded file.

Expected behavior

The root site index at https://pydantic.dev/llms.txt advertises the site-wide documentation index as "All docs" and describes it as a "root index linking each library's llms.txt and llms-full.txt, with instructions for agents". The documentation homepage at https://pydantic.dev/docs/ includes Monty alongside the other products. Monty should therefore be discoverable through that root documentation index, with links to its available library-specific indexes.

Actual behavior

The commands printed:

Mentions Monty: False
Monty index link: False
Monty full index link: False
200
200

The site-wide file says "This site contains the documentation for:" and lists only Pydantic Validation, Pydantic AI and Pydantic Logfire. It has library sections for those same three products and no Monty mention or index link. The HTML documentation homepage links to /docs/monty/get-started/, and Monty's two index endpoints both return HTTP 200.

Evidence

  • Expected source: the root site index's "Documentation indexes" section advertises "All docs" and links each library's indexes; the live documentation homepage includes Monty.
  • Failure source: the live site-wide documentation index downloaded by the reproduction commands omits Monty entirely while both Monty index endpoints return HTTP 200.
  • Evidence provenance: observed
  • Local verification: reproduced
  • Reproduction completeness: complete

Monty's public documentation publication workflow at https://github.com/pydantic/monty/blob/main/.github/workflows/ci.yml names pydantic/unified-docs as the documentation-site builder and dispatches docs-update to it. That repository was not accessible through the GitHub API during this investigation, so the site-wide index generator and cause of the omission were not inspected. The public source baseline establishes that Monty publishes documentation to the unified site; it does not establish the live site's build revision.

Restoration check

Fetch the site-wide file again and verify that all three booleans print True, with usable links to both Monty indexes. The existing Validation, AI and Logfire index links must remain available. This report concerns site-wide library discovery; the separate Monty page omissions tracked in https://github.com/pydantic/monty/issues/977 have their own restoration check and do not need to be changed to close this report.

Triage assessment

  • Impact level: P2
  • Assessment status: supported
  • Impact basis: Agents that use the advertised "All docs" index cannot discover the Monty library indexes through that entry point. The failure is bounded to documentation discovery; Monty's documentation and its indexes remain accessible through their direct URLs.
  • Workaround status: available
  • Workaround basis: The documentation homepage links Monty, and fetching the library-specific index endpoints directly succeeds. Using those routes preserves access to Monty's published documentation.

Activity

0

No activity yet.