Add llms.txt support to docs #14
Merged
Conversation
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
Add llmstxt plugin configuration to generate structured documentation output for LLM consumption with project description and section mapping. Co-Authored-By: Claude <noreply@anthropic.com>
- Delete docs/troubleshooting.md (empty placeholder file) - Remove troubleshooting references from developing-bots.md, installation.md, and protocol-api.md - Update mkdocs.yml navigation to remove troubleshooting entry - Update .claude/settings.json mdformat command to exclude deleted file Co-Authored-By: Claude <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR integrates support for generating llms.txt and llms-full.txt versions of the documentation via a new MkDocs plugin, and cleans up references to the old troubleshooting page.
- Adds the
mkdocs-llmstxtplugin to bothpyproject.tomlandmkdocs.yml. - Updates site navigation (
index.mdandmkdocs.yml) to link to the new LLM-friendly docs. - Removes the standalone
troubleshooting.mdcontent and its references from other docs and formatting scripts.
Reviewed Changes
Copilot reviewed 8 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| pyproject.toml | Added mkdocs-llmstxt>=0.3.0 to dev dependencies |
| mkdocs.yml | Configured llmstxt plugin and removed troubleshooting nav |
| docs/troubleshooting.md | Cleared out the troubleshooting page |
| docs/protocol-api.md | Removed troubleshooting link |
| docs/installation.md | Removed troubleshooting reference |
| docs/index.md | Updated labels and added links for llms.txt and llms-full.txt |
| docs/developing-bots.md | Removed troubleshooting guide reference |
| .claude/settings.json | Removed troubleshooting.md from formatting command |
Comments suppressed due to low confidence (2)
docs/index.md:40
- [nitpick] Consider renaming this label to something more descriptive like
llms.txt Documentationto clarify that it refers to the generated LLM docs.
- :octicons-sparkle-fill-16:{ .lg .middle } __Documentation for LLM__
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
No description provided.