From 8d39cecbf416563c889665c64298e107291a3eb9 Mon Sep 17 00:00:00 2001 From: kitsune-hash Date: Thu, 12 Feb 2026 13:42:48 +0100 Subject: [PATCH 1/2] feat: add llms.txt support via mkdocs-llmstxt-md plugin - Adds mkdocs-llmstxt-md plugin for LLM-friendly documentation - Generates /llms.txt (index) and /llms-full.txt (complete docs) - Serves raw markdown at .md URLs alongside HTML pages - Adds copy-to-markdown button on each page - All doc sections mapped with descriptions Ref: https://llmstxt.org/ --- mkdocs.yml | 27 +++++++++++++++++++++++++++ requirements.txt | 1 + 2 files changed, 28 insertions(+) diff --git a/mkdocs.yml b/mkdocs.yml index aaf4e9a..14872e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,6 +36,33 @@ theme: plugins: - search - tags + - llms-txt: + sections: + Getting Started: + - getting-started/index.md: "Introduction to runqy" + - getting-started/installation.md: "Installation methods (CLI, Docker, source)" + - getting-started/quickstart.md: "Quick start guide with Docker Compose" + - getting-started/architecture.md: "Architecture overview and concepts" + Server: + - server/index.md: "Server overview" + - server/configuration.md: "Server configuration reference" + - server/cli.md: "CLI commands reference" + - server/api.md: "REST API reference (enqueue, batch, task status)" + Worker: + - worker/index.md: "Worker overview" + - worker/configuration.md: "Worker configuration reference" + - worker/deployment.md: "Deployment and bootstrap process" + Python SDK: + - python-sdk/index.md: "Python SDK overview" + - python-sdk/installation.md: "SDK installation" + - python-sdk/decorators.md: "Task decorators (@task, @load)" + - python-sdk/examples.md: "Code examples" + Guides: + - guides/local-development.md: "Local development setup" + - guides/enqueueing-tasks.md: "How to enqueue tasks" + - guides/result-delivery.md: "Getting task results" + - guides/vaults.md: "Secrets management with Vaults" + - guides/monitoring.md: "Monitoring and metrics" markdown_extensions: - pymdownx.emoji: diff --git a/requirements.txt b/requirements.txt index 025b650..da0407b 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ mkdocs>=1.5.0 mkdocs-material>=9.5.0 +mkdocs-llmstxt-md>=0.1.0 From acd33cc4307b4c6279a58151d235b06963ff4657 Mon Sep 17 00:00:00 2001 From: kitsune-hash Date: Wed, 18 Feb 2026 09:15:27 +0100 Subject: [PATCH 2/2] fix: correct llmstxt plugin name in mkdocs.yml Plugin registers as 'llmstxt-md', not 'llms-txt'. --- mkdocs.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs.yml b/mkdocs.yml index 14872e7..a558bbd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -36,7 +36,7 @@ theme: plugins: - search - tags - - llms-txt: + - llmstxt-md: sections: Getting Started: - getting-started/index.md: "Introduction to runqy"