Skip to content

armgit / dspy

Public Imported from GitHub
0

DSPy: The framework for programming—not prompting—language models

Python

docs: complete llmstxt plugin with full nav sections (#9307)

Rehan Ahmed8d9312400690
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index 89bb14e95..98fb81f16 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -266,32 +266,29 @@ plugins:
It provides a systematic approach to building AI applications through composable modules,
optimization techniques, and evaluation frameworks.
sections:
- Getting Started:
+ Get Started:
- index.md: DSPy overview and quick start guide
+ Learn DSPy - Learning DSPy:
+ - learn/index.md: Three stages of building AI systems - programming, evaluation, and optimization
+ Learn DSPy - DSPy Programming:
+ - learn/programming/**.md
+ Learn DSPy - DSPy Evaluation:
+ - learn/evaluation/**.md
+ Learn DSPy - DSPy Optimization:
+ - learn/optimization/**.md
+ # Since we don't have a learn/**.md, future sections within learn/ should be added here
+ # to ensure they show up in the llms.txt navigation
+ Tutorials - Docs:
+ - tutorials/**.md
+ Tutorials - Notebooks:
+ - tutorials/**.ipynb
+ Community:
+ - community/**.md
+ FAQ:
+ - faqs.md: Common questions on DSPy usage, comparisons, optimization, and debugging
- cheatsheet.md: DSPy cheatsheet for quick reference
- Core Concepts:
- - learn/programming/overview.md: Programming paradigm and philosophy
- - learn/programming/signatures.md: Signatures - declarative input/output specifications
- - learn/programming/modules.md: Modules - composable AI components
- - learn/programming/language_models.md: Language model interfaces and configuration
- Essential Tutorials:
- - tutorials/rag/index.ipynb: Retrieval-Augmented Generation (RAG) tutorial
- - tutorials/classification/index.md: Classification with DSPy
- - tutorials/agents/index.ipynb: Building AI agents with DSPy
- Optimization:
- - learn/optimization/overview.md: Optimization techniques overview
- - tutorials/optimize_ai_program/index.md: Guide to optimizing AI programs
- - api/optimizers/BootstrapFewShot.md: Bootstrap few-shot optimizer
- Key Modules API:
- - api/modules/Predict.md: Basic prediction module
- - api/modules/ChainOfThought.md: Chain of thought reasoning
- - api/modules/ReAct.md: ReAct agent module
- Core API Reference:
- - api/signatures/Signature.md: Signature system documentation
- - api/primitives/Example.md: Example primitive for training data
- Production:
- - tutorials/deployment/index.md: Production deployment guide
- - tutorials/observability/index.md: Debugging and observability
+ API Reference:
+ - api/**.md
extra:
social:
diff --git a/tests/docs/test_mkdocs_links.py b/tests/docs/test_mkdocs_links.py
index 0fad37ccb..f2630c894 100644
--- a/tests/docs/test_mkdocs_links.py
+++ b/tests/docs/test_mkdocs_links.py
@@ -17,7 +17,7 @@ def test_nav_files_exist():
# Get markdown files
md_files = []
for line in lines:
- if ".md" in line:
+ if ".md" in line and "*.md" not in line: # Ignore patterns in llmstxt: plugin
# Extract the markdown filename and clean it up
md_file = line.strip().split(":")[-1].strip()
# Remove list markers and quotes