Add llms.txt generation#1348
Open
thomasbergernz wants to merge 1 commit into
Open
Conversation
Generates public/llms.txt on build, indexed by the 10 top-level nav sections plus a Reference section for GLOSSARY/index, so LLMs have a machine-readable entry point to the docs per llmstxt.org.
Contributor
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
mkdocs-llmstxtplugin somkdocs buildemitspublic/llms.txt— a machine-readable index for LLMs per the llms.txt spec.docs/.pages.yml, plus a Reference section forGLOSSARY.md/index.md. Root contributor/meta pages (CONTRIBUTING.md,FORMAT.md,NEWPAGE.md,MACROS.md,tags.md,mermaid-test.md,updates.md) and the stale, content-lessGeneral//Scientific_Computing/dirs are excluded.llms.txtonly — nollms-full.txt, to avoid a multi-MB addition to the Pages deploy artifact across 306 pages.requirements.in/requirements.txtupdated (pip-compile) to pinmkdocs-llmstxt==0.5.0and its deps (beautifulsoup4,markdownify,mdformat,mdformat-tables) — no version conflicts with the existingmkdocs < 2.0pin.Test plan
mkdocs build --cleansucceeds locally,public/llms.txthas all 11 sections with working links./checks/run_test_build.pyfrom a clean state: exit 0, no llmstxt-related warnings (pre-existing nav/redirect warnings unchanged)checks/run_aria_check.pypasses — only globs*.html, unaffected by the new sibling.mdfiles the plugin writes intopublic/checks.yml) green on this PRdemo_deploy.yml): fetch<preview-url>/llms.txtand spot-check a couple linked pages🤖 Generated with Claude Code