docs: Added llms.txt #206
Merged
docs: Added llms.txt #206
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
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Copilot finished reviewing on behalf of
xelandernt
November 11, 2025 08:18
There was a problem hiding this comment.
Pull Request Overview
This PR adds support for the llms.txt format to the project documentation by integrating the mkdocs-llmstxt plugin, which generates machine-readable documentation files for large language models.
- Added the
mkdocs-llmstxtplugin dependency and configuration - Configured comprehensive documentation sections mapping for LLM consumption
- Added llms.txt badge and reference to the documentation
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| pyproject.toml | Added mkdocs-llmstxt>=0.4.0 as a development dependency and removed an outdated comment |
| mkdocs.yml | Configured the llmstxt plugin with sections mapping all major documentation areas |
| docs/index.md | Added a new section documenting the availability of llms.txt file |
| README.md | Added llms.txt badge to the project badges section |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
No description provided.