Skip to content

chore: Add llms.txt to documentation #3953

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: main
Choose a base branch
from

Conversation

hjgraca
Copy link
Contributor

@hjgraca hjgraca commented May 21, 2025

Summary

Changes

Added missing requirements and run pip-compile.

This pull request introduces updates to documentation dependencies and configuration, primarily to integrate the mkdocs-llmstxt plugin and its associated resources.

Dependency Updates:

  • Added mkdocs-llmstxt==0.2.0 to docs/requirements.in and docs/requirements.txt for generating additional documentation outputs. [1] [2]
  • Included new dependencies in docs/requirements.txt to support Markdown and HTML processing:
    • beautifulsoup4==4.13.4 (via markdownify and mkdocs-llmstxt).
    • markdown-it-py==3.0.0 and mdurl==0.1.2 (via mdformat). [1] [2]
    • markdownify==1.1.0 (via mkdocs-llmstxt).
    • mdformat==0.7.22 (via mkdocs-llmstxt).
    • soupsieve==2.7 and typing-extensions==4.13.2 (via beautifulsoup4).

Configuration Changes:

  • Updated mkdocs.yml to add a new "Resources" section in the navigation, linking to llms.txt and its full version.
  • Configured the llmstxt plugin in mkdocs.yml with detailed settings, including descriptions, output paths, and categorized sections for documentation.

Minor Adjustments:

  • Corrected Python version metadata in docs/requirements.txt to reflect Python 3.10 instead of 3.13.

Issue number: #3952

image


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 21, 2025
@pull-request-size pull-request-size bot added the size/L PRs between 100-499 LOC label May 21, 2025
- environment-variables.md
Upgrade guide:
- upgrade.md
Processes:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For now I'd exclude this entire section

Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my side let's remove the Processes section for now, since it's something I don't expect will help customers write better functions using Powertools.

After that I'm good to merge this.

@dreamorosi dreamorosi requested review from dreamorosi and removed request for am29d May 21, 2025 14:04
@dreamorosi dreamorosi linked an issue May 21, 2025 that may be closed by this pull request
1 task
Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry I dismissed by mistake, see previous comment.

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 size/L PRs between 100-499 LOC
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: Add llms.txt to documentation
2 participants