Skip to content

Add autogeneration of llms.txt during mkdocs build; add docs page on using llms.txt - #1023

Merged
koverholt merged 17 commits into
mainfrom
llms-txt-mkdocs
Dec 5, 2025
Merged

Add autogeneration of llms.txt during mkdocs build; add docs page on using llms.txt#1023
koverholt merged 17 commits into
mainfrom
llms-txt-mkdocs

Conversation

@koverholt

@koverholt koverholt commented Dec 3, 2025

Copy link
Copy Markdown
Collaborator

Automates generation of llms.txt in the docs root and adds a docs page for consuming it with AI coding tools. This PR:

  • Adds support for llms.txt auto generation using the mkdocs-llmstxt package (updated requirements.txt and mkdocs.yml)
  • Adds a documentation page for using llms.txt (with Gemini CLI, Antigravity, and general info for other clients)
  • Remove manually generated llms.txt and llms-full.txt from Git (these will now be autogenerated and served at the docs site route)
  • Fixed a bunch of docs warnings and INFO logs

After this PR is merged, the llms.txt will be autogenerated and available at:

And .md files will be automatically generated alongside the built HTML pages for easy ingestion by LLMs / coding tools.

Related issues:

@koverholt

koverholt commented Dec 3, 2025

Copy link
Copy Markdown
Collaborator Author

The doc build CI check is failing due to --strict mode because mkdocs-llmstxt is emitting warnings related to unreferenced assets (images, JS, CSS). But the actual docs build will still pass. I'll see if I can figure out a good compromise for that failing test in this PR, otherwise I can handle it in a followup PR.

@koverholt

Copy link
Copy Markdown
Collaborator Author

I fixed the CI docs build warnings by reworking the globs in the mkdocs-llmstxt config in 0d09c7e and 9e39aee.

@koverholt

koverholt commented Dec 3, 2025

Copy link
Copy Markdown
Collaborator Author

I also opened an issue here: derailed-dash/adk-docs-ext#1 so that the Gemini CLI extension for ADK docs listed on https://geminicli.com/extensions/ will continue to work given the change to llms.txt in this PR.

@joefernandez joefernandez left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Tested locally and reviewed. Thanks!

koverholt added a commit to sabrenner/google-adk-docs that referenced this pull request Apr 28, 2026
…using llms.txt (google#1023)

* Add mkdocs-llmstxt and related config

* Remove existing llms.txt and llms-full.txt from repo

* Add docs page for llms.txt

* Minor edit

* Minor edit

* Add *.md to glob syntax in mkdocs-llmstxt config

* Add explicit URLs in API reference section to avoid build warnings

* Fix all build warnings related to bad cross-links and incorrect anchor links

* Suppress INFO logs about absolute links - the CI link checker will catch any issues

* Fix remaining build warnings

* Add Gemini CLI instructions

* Fix link to bidi tutorial
koverholt added a commit to sabrenner/google-adk-docs that referenced this pull request Apr 28, 2026
…using llms.txt (google#1023)

* Add mkdocs-llmstxt and related config

* Remove existing llms.txt and llms-full.txt from repo

* Add docs page for llms.txt

* Minor edit

* Minor edit

* Add *.md to glob syntax in mkdocs-llmstxt config

* Add explicit URLs in API reference section to avoid build warnings

* Fix all build warnings related to bad cross-links and incorrect anchor links

* Suppress INFO logs about absolute links - the CI link checker will catch any issues

* Fix remaining build warnings

* Add Gemini CLI instructions

* Fix link to bidi tutorial
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants