Skip to content

Commit b404e07

Browse files
arieradleclaude
andcommitted
docs: add llms.txt and llms-full.txt for AI agent discoverability
Adds mkdocs-llmstxt plugin generating: - /llms.txt — structured index (title, description, all page links) readable by Perplexity, ChatGPT, Claude, Cursor, and AI crawlers - /llms-full.txt — full concatenated docs content (9k+ lines) for AI tools that ingest the entire knowledge base in one shot Sections cover all 38 pages across Getting Started, Usage Guide, Integrations, Reference, and Architecture. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 865efb0 commit b404e07

3 files changed

Lines changed: 49 additions & 0 deletions

File tree

.github/workflows/docs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ jobs:
2929
mkdocs-mermaid2-plugin \
3030
mkdocs-minify-plugin \
3131
mkdocs-rss-plugin \
32+
mkdocs-llmstxt \
3233
mike
3334
3435
- name: Build docs

mkdocs.yml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,53 @@ plugins:
100100
as_creation: date
101101
categories:
102102
- tags
103+
- llmstxt:
104+
full_output: "llms-full.txt"
105+
markdown_description: |
106+
Shekel enforces hard LLM spend limits in Python with one line of code.
107+
Supports OpenAI, Anthropic, LiteLLM, Gemini, LangGraph, CrewAI, OpenAI Agents SDK, MCP, and more.
108+
Key features: hard USD caps, loop detection, velocity limits, per-node/agent/task circuit breakers, Redis distributed budgets.
109+
sections:
110+
Getting Started:
111+
- index.md
112+
- installation.md
113+
- quickstart.md
114+
Usage Guide:
115+
- usage/basic-usage.md
116+
- usage/nested-budgets.md
117+
- usage/budget-enforcement.md
118+
- usage/fallback-models.md
119+
- usage/loop-guard.md
120+
- usage/spend-velocity.md
121+
- usage/tool-budgets.md
122+
- usage/temporal-budgets.md
123+
- usage/distributed-budgets.md
124+
- usage/accumulating-budgets.md
125+
- usage/streaming.md
126+
- usage/decorators.md
127+
Integrations:
128+
- integrations/litellm.md
129+
- integrations/langgraph.md
130+
- integrations/crewai.md
131+
- integrations/openai-agents.md
132+
- integrations/openai.md
133+
- integrations/anthropic.md
134+
- integrations/gemini.md
135+
- integrations/huggingface.md
136+
- integrations/langfuse.md
137+
- integrations/otel.md
138+
Reference:
139+
- cli.md
140+
- docker.md
141+
- api-reference.md
142+
- models.md
143+
Architecture:
144+
- how-it-works.md
145+
- architecture/overview.md
146+
- architecture/components.md
147+
- architecture/data-flow.md
148+
- architecture/extensibility.md
149+
- architecture/concurrency.md
103150
- mermaid2
104151

105152
markdown_extensions:

pyproject.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,7 @@ dev = [
9999
"mkdocs-mermaid2-plugin>=1.0.0",
100100
"mkdocs-minify-plugin>=0.8.0",
101101
"mkdocs-rss-plugin>=1.17.0",
102+
"mkdocs-llmstxt>=0.5.0",
102103
"google-genai>=1.0.0",
103104
"huggingface-hub>=0.20.0",
104105
"opentelemetry-api>=1.0.0",

0 commit comments

Comments
 (0)