chore: Add llms.txt to documentation #893
Merged
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.
Issue number: #892
Summary
Changes
This pull request updates the documentation dependencies and configuration to include support for generating LLM (Large Language Model)-specific text outputs. Key changes include the addition of new dependencies, updates to the
mkdocs.yml
configuration, and adjustments to therequirements
files.Dependency Updates:
mkdocs-llmstxt==0.2.0
todocs/requirements.in
anddocs/requirements.txt
to enable LLM-specific text generation. [1] [2]beautifulsoup4
,markdown-it-py
,markdownify
,mdformat
, andmdurl
to support the new plugin and its functionality. [1] [2] [3]Configuration Updates:
mkdocs.yml
to include a new "Resources" section in the navigation menu, linking to LLM-specific text files (llms.txt
andllms-full.txt
).llmstxt
plugin inmkdocs.yml
with descriptions, output paths, and specific sections for generating structured LLM text outputs.User experience
Checklist
Please leave checklist items unchecked if they do not apply to your change.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.