Skip to content

chore: Add llms.txt to documentation #893

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2025
Merged

chore: Add llms.txt to documentation #893

merged 1 commit into from
May 23, 2025

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented May 20, 2025

Please provide the issue number

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 the requirements files.

Dependency Updates:

  • Added mkdocs-llmstxt==0.2.0 to docs/requirements.in and docs/requirements.txt to enable LLM-specific text generation. [1] [2]
  • Introduced dependencies such as beautifulsoup4, markdown-it-py, markdownify, mdformat, and mdurl to support the new plugin and its functionality. [1] [2] [3]

Configuration Updates:

  • Updated mkdocs.yml to include a new "Resources" section in the navigation menu, linking to LLM-specific text files (llms.txt and llms-full.txt).
  • Configured the llmstxt plugin in mkdocs.yml with descriptions, output paths, and specific sections for generating structured LLM text outputs.

User experience

Please share what the user experience looks like before and after this change

Checklist

Please leave checklist items unchecked if they do not apply to your change.

Is this a breaking change?

RFC issue number:

Checklist:

  • Migration process documented
  • Implement warnings (if it can live side by side)

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.

@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 20, 2025
@pull-request-size pull-request-size bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label May 20, 2025
@github-actions github-actions bot added the internal Maintenance changes label May 20, 2025
Copy link

@hjgraca hjgraca requested a review from leandrodamascena May 23, 2025 10:08
@hjgraca hjgraca merged commit 447506b into develop May 23, 2025
5 checks passed
@hjgraca hjgraca deleted the chore/docs-llmstxt branch May 23, 2025 13:24
@hjgraca hjgraca linked an issue May 29, 2025 that may be closed by this pull request
1 task
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Maintenance changes size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Maintenance: Add llms.txt to documentation site
2 participants