Skip to content

Conversation

@ryanycoleman
Copy link
Member

Description

Using the mkdocs-llmstxt plugin, we can generate llms.txt which describes the project and points LLMs towards markdown twins of specific documentation hosted for humans as HTML. These twins are generated during the build process and served as *.md. See: https://llmstxt.org/ & https://pypi.org/project/mkdocs-llmstxt/

Type of Change

New mkdocs plugin and hosted content (llms.txt & *.md files)

Motivation and Context

Makes it easier for LLMs to understand Strands: https://llmstxt.org/

Areas Affected

Changes mkdocs configuration and hosted content.

Screenshots

Screenshot 2025-05-27 at 9 13 00 PM

Checklist

  • [x ] I have read the CONTRIBUTING document
  • [x ] My changes follow the project's documentation style
  • [x ] I have tested the documentation locally using mkdocs serve
  • [x ] Links in the documentation are valid and working
  • [x ] Images/diagrams are properly sized and formatted
  • [x ] All new and existing tests pass

Additional Notes

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Using the mkdocs-llmstxt plugin, we can generate llms.txt which
describes the project and points LLMs towards markdown twins of
specific documentation hosted for humans as HTML. These twins are
generated during the build process and served as *.md.
See: https://llmstxt.org/ & https://pypi.org/project/mkdocs-llmstxt/
@ryanycoleman ryanycoleman requested a review from yonib05 May 28, 2025 04:14
yonib05
yonib05 previously approved these changes May 28, 2025
zastrowm
zastrowm previously approved these changes May 28, 2025
Co-authored-by: Mackenzie Zastrow <3211021+zastrowm@users.noreply.github.com>
@ryanycoleman ryanycoleman dismissed stale reviews from zastrowm and yonib05 via 931addc May 29, 2025 02:57
@ryanycoleman ryanycoleman enabled auto-merge (squash) May 29, 2025 15:16
@ryanycoleman ryanycoleman merged commit 10ab59a into strands-agents:main May 29, 2025
1 check passed
pgrayy added a commit to pgrayy/docs that referenced this pull request May 30, 2025
awsarron pushed a commit that referenced this pull request May 30, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants