From 3290c0a2487f5546caabc1c18fe8bf470e88241b Mon Sep 17 00:00:00 2001 From: Ryan Coleman Date: Tue, 27 May 2025 21:07:41 -0700 Subject: [PATCH 1/2] Serve llms.txt via mkdocs-llmstxt plugin 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/ --- mkdocs.yml | 21 +++++++++++++++++++++ requirements.txt | 1 + 2 files changed, 22 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index d5db585f..d66be8d6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,7 @@ site_name: Strands Agents SDK site_description: Documentation for Strands Agents, a simple-to-use, code-first, lightweight library for building AI agents site_dir: site +site_url: https://strandsagents.com repo_url: https://github.com/strands-agents/sdk-python @@ -145,6 +146,26 @@ plugins: docstring_style: google show_root_heading: true show_source: true + - llmstxt: + markdown_description: Documentation for Strands Agents, a simple-to-use, code-first, lightweight library for building AI agents + sections: + User Guide: + - README.md + - user-guide/quickstart.md + - user-guide/concepts/agents/*.md + - user-guide/concepts/tools/*.md + - user-guide/concepts/model-providers/*.md + - user-guide/concepts/streaming/*.md + - user-guide/concepts/multi-agent/*.md + - user-guide/safety-security/*.md + - user-guide/observability-evaluation/*.md + - user-guide/deploy/*.md + Examples: + - examples/README.md + - examples/python/*.md + - examples/cdk/*/*.md + API Reference: + - api-reference/*.md extra: social: diff --git a/requirements.txt b/requirements.txt index aeb8c7a1..bb72dc4e 100644 --- a/requirements.txt +++ b/requirements.txt @@ -4,4 +4,5 @@ mkdocs-macros-plugin~=1.3.7 mkdocs-material~=9.6.12 mkdocs-macros-plugin~=1.3.7 mkdocstrings-python~=1.16.10 +mkdocs-llmstxt~=0.2.0 strands-agents~=0.1.0 From 931addc83dae8585635c6e760b95828353fc067b Mon Sep 17 00:00:00 2001 From: Ryan Coleman Date: Wed, 28 May 2025 19:57:49 -0700 Subject: [PATCH 2/2] llms.txt expand selection of user-guide and examples Co-authored-by: Mackenzie Zastrow <3211021+zastrowm@users.noreply.github.com> --- mkdocs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/mkdocs.yml b/mkdocs.yml index d66be8d6..acdd1bae 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -151,7 +151,7 @@ plugins: sections: User Guide: - README.md - - user-guide/quickstart.md + - user-guide/**/*.md - user-guide/concepts/agents/*.md - user-guide/concepts/tools/*.md - user-guide/concepts/model-providers/*.md @@ -161,7 +161,7 @@ plugins: - user-guide/observability-evaluation/*.md - user-guide/deploy/*.md Examples: - - examples/README.md + - examples/**/*.md - examples/python/*.md - examples/cdk/*/*.md API Reference: