chore: Add llms.txt to documentation #3953
Merged
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
boring-cyborg
bot
added
the
documentation
dreamorosi
reviewed
May 21, 2025
dreamorosi
requested changes
May 21, 2025
Contributor
dreamorosi
left a comment
dreamorosi
left a comment
There was a problem hiding this comment.
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.
1 task
dreamorosi
requested changes
May 21, 2025
Contributor
There was a problem hiding this comment.
Sorry I dismissed by mistake, see previous comment.
|
dreamorosi
approved these changes
May 22, 2025
Contributor
dreamorosi
left a comment
dreamorosi
left a comment
There was a problem hiding this comment.
Thank you for adding, I have confirmed that the files are generated correctly - still unclear whether they'll be useful, but that's another story.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Changes
Added missing requirements and run pip-compile.
This pull request introduces updates to documentation dependencies and configuration, primarily to integrate the
mkdocs-llmstxtplugin and its associated resources.Dependency Updates:
mkdocs-llmstxt==0.2.0todocs/requirements.inanddocs/requirements.txtfor generating additional documentation outputs. [1] [2]docs/requirements.txtto support Markdown and HTML processing:beautifulsoup4==4.13.4(viamarkdownifyandmkdocs-llmstxt).markdown-it-py==3.0.0andmdurl==0.1.2(viamdformat). [1] [2]markdownify==1.1.0(viamkdocs-llmstxt).mdformat==0.7.22(viamkdocs-llmstxt).soupsieve==2.7andtyping-extensions==4.13.2(viabeautifulsoup4).Configuration Changes:
mkdocs.ymlto add a new "Resources" section in the navigation, linking tollms.txtand its full version.llmstxtplugin inmkdocs.ymlwith detailed settings, including descriptions, output paths, and categorized sections for documentation.Minor Adjustments:
docs/requirements.txtto reflect Python 3.10 instead of 3.13.Issue number: #3952
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.