Skip to content

chore: Add llms.txt to documentation #6693

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

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented May 20, 2025

Issue number: #6692

Summary

Changes

Added missing requirements and run pip-compile.

This pull request updates the documentation build system by adding new dependencies, configuring plugins, and enhancing the mkdocs.yml file. The changes introduce new tools for generating and managing documentation content, including support for LLMs (Large Language Models) and Python docstring extraction.

Dependency Updates:

  • Added mkdocstrings-python and mkdocs-llmstxt to docs/requirements.in for Python docstring extraction and LLM-related functionality.
  • Updated docs/requirements.txt to include new dependencies such as beautifulsoup4, griffe, markdownify, mkdocstrings, mkdocs-autorefs, and others, along with their respective hashes. These dependencies support enhanced documentation features like markdown processing, auto-references, and LLM integration. [1] [2] [3] [4] [5] [6] [7]

mkdocs.yml Enhancements:

  • Added a new "Resources" section to the navigation (nav) with links to llms.txt and its full version.
  • Configured the llmstxt plugin with a detailed markdown description, output file paths, and organized sections for project documentation, core utilities, and processes.

These updates streamline documentation generation and improve its structure, making it easier to maintain and extend.

User experience

image

Checklist

If your change doesn't seem to apply, please leave them unchecked.

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.

@hjgraca hjgraca requested a review from a team as a code owner May 20, 2025 18:13
@hjgraca hjgraca requested a review from leandrodamascena May 20, 2025 18:13
@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
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 20, 2025
@github-actions github-actions bot added internal Maintenance changes and removed documentation Improvements or additions to documentation labels May 20, 2025
@boring-cyborg boring-cyborg bot added the documentation Improvements or additions to documentation label May 21, 2025
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.

1 participant