Skip to content

Commit 83a6dae

Browse files
committed
Issue #244: Update examples README.md with documentation links for all 24 newly documented pipelines
1 parent 494d758 commit 83a6dae

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

examples/README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,13 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
2727
- Intelligent model selection based on task complexity
2828
- Cost-optimized routing with fallback strategies
2929
- Quality vs efficiency tradeoffs
30+
- **Docs**: [model_routing_demo.md](../docs/examples/model_routing_demo.md)
3031

3132
3. **[llm_routing_pipeline.yaml](llm_routing_pipeline.yaml)** - Smart LLM Routing Pipeline
3233
- Advanced routing logic with prompt optimization
3334
- Automatic task complexity analysis
3435
- Performance monitoring and adaptation
36+
- **Docs**: [llm_routing_pipeline.md](../docs/examples/llm_routing_pipeline.md)
3537

3638
### 🔬 Research & Analysis
3739
4. **[research_minimal.yaml](research_minimal.yaml)** - Minimal Research Pipeline
@@ -44,21 +46,25 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
4446
- Standard research with structured analysis
4547
- Multiple search strategies and content analysis
4648
- Professional report formatting
49+
- **Docs**: [research_basic.md](../docs/examples/research_basic.md)
4750

4851
6. **[research_advanced_tools.yaml](research_advanced_tools.yaml)** - Research Pipeline with Advanced Tools
4952
- Uses headless browser, PDF compiler, report generator
5053
- Professional publication-quality output
5154
- Advanced scraping and citation handling
55+
- **Docs**: [research_advanced_tools.md](../docs/examples/research_advanced_tools.md)
5256

5357
7. **[web_research_pipeline.yaml](web_research_pipeline.yaml)** - Web Research Automation
5458
- Comprehensive web research with validation
5559
- Multi-source aggregation and cross-referencing
5660
- Quality scoring and source credibility assessment
61+
- **Docs**: [web_research_pipeline.md](../docs/examples/web_research_pipeline.md)
5762

5863
8. **[working_web_search.yaml](working_web_search.yaml)** - Web Search and Summary
5964
- Basic web search with immediate summarization
6065
- Quick fact-finding and verification
6166
- Simple output format
67+
- **Docs**: [working_web_search.md](../docs/examples/working_web_search.md)
6268

6369
9. **[enhanced_research_pipeline.yaml](enhanced_research_pipeline.yaml)** - Enhanced Research Pipeline
6470
- Advanced research with tool integration
@@ -85,11 +91,13 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
8591
- Statistical computation and visualization
8692
- Data exploration and hypothesis testing
8793
- Chart generation and statistical reporting
94+
- **Docs**: [statistical_analysis.md](../docs/examples/statistical_analysis.md)
8895

8996
14. **[validation_pipeline.yaml](validation_pipeline.yaml)** - Data Validation Pipeline
9097
- Schema validation and data quality checks
9198
- Structured data extraction and verification
9299
- Compliance and format validation
100+
- **Docs**: [validation_pipeline.md](../docs/examples/validation_pipeline.md)
93101

94102
### 🔄 Control Flow & Iteration
95103
15. **[control_flow_conditional.yaml](control_flow_conditional.yaml)** - Conditional File Processing
@@ -122,6 +130,7 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
122130
- Until condition processing patterns
123131
- Threshold-based termination
124132
- Quality-driven iteration
133+
- **Docs**: [until_condition_examples.md](../docs/examples/until_condition_examples.md)
125134

126135
21. **[enhanced_until_conditions_demo.yaml](enhanced_until_conditions_demo.yaml)** - Advanced Until Conditions
127136
- Complex until conditions with multi-criteria evaluation
@@ -150,11 +159,13 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
150159
25. **[iterative_fact_checker.yaml](iterative_fact_checker.yaml)** - Iterative Fact Verification
151160
- Multi-pass fact checking with refinement
152161
- Progressive verification and evidence gathering
162+
- **Docs**: [iterative_fact_checker.md](../docs/examples/iterative_fact_checker.md)
153163
- **Outputs**: [fact_checking_report.md](outputs/iterative_fact_checker/fact_checking_report.md)
154164

155165
26. **[iterative_fact_checker_simple.yaml](iterative_fact_checker_simple.yaml)** - Simple Iterative Fact-Checker
156166
- Streamlined iterative fact verification
157167
- Basic claim validation workflow
168+
- **Docs**: [iterative_fact_checker_simple.md](../docs/examples/iterative_fact_checker_simple.md)
158169
- **Outputs**: [fact_checking_report.md](outputs/iterative_fact_checker_simple/fact_checking_report.md)
159170

160171
### 💻 Code & System Operations
@@ -167,6 +178,7 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
167178
- System discovery and automated setup
168179
- Environment configuration and validation
169180
- Command execution and monitoring
181+
- **Docs**: [terminal_automation.md](../docs/examples/terminal_automation.md)
170182

171183
### 🔌 Integration & Advanced Features
172184
29. **[mcp_integration_pipeline.yaml](mcp_integration_pipeline.yaml)** - MCP Integration Pipeline
@@ -177,66 +189,78 @@ python scripts/run_pipeline.py examples/[example_name].yaml -i key=value -i anot
177189
30. **[mcp_memory_workflow.yaml](mcp_memory_workflow.yaml)** - MCP Memory Context Management
178190
- Persistent context and state management
179191
- Cross-session memory and retrieval
192+
- **Docs**: [mcp_memory_workflow.md](../docs/examples/mcp_memory_workflow.md)
180193
- **Outputs**: [User context summaries](outputs/mcp_memory_workflow/)
181194

182195
31. **[mcp_simple_test.yaml](mcp_simple_test.yaml)** - Basic MCP Testing
183196
- Simple MCP functionality validation
184197
- Connection testing and basic operations
185198
- Integration verification
199+
- **Docs**: [mcp_simple_test.md](../docs/examples/mcp_simple_test.md)
186200

187201
32. **[modular_analysis_pipeline.yaml](modular_analysis_pipeline.yaml)** - Modular Analysis Pipeline
188202
- Sub-pipeline orchestration and composition
189203
- Modular architecture with data visualization
204+
- **Docs**: [modular_analysis_pipeline.md](../docs/examples/modular_analysis_pipeline.md)
190205
- **Outputs**: [Dashboard and charts](outputs/modular_analysis/)
191206

192207
33. **[interactive_pipeline.yaml](interactive_pipeline.yaml)** - Interactive Data Processing
193208
- User input integration and approval gates
194209
- Feedback collection and adaptive processing
210+
- **Docs**: [interactive_pipeline.md](../docs/examples/interactive_pipeline.md)
195211
- **Outputs**: [Interactive results](outputs/interactive_pipeline/)
196212

197213
### ⚠️ Error Handling & Reliability
198214
34. **[error_handling_examples.yaml](error_handling_examples.yaml)** - Error Handling Examples
199215
- Comprehensive error handling patterns
200216
- Recovery strategies and fallback mechanisms
201217
- Graceful degradation techniques
218+
- **Docs**: [error_handling_examples.md](../docs/examples/error_handling_examples.md)
202219

203220
35. **[simple_error_handling.yaml](simple_error_handling.yaml)** - Basic Error Handling
204221
- Simple error detection and recovery
205222
- Basic retry logic and error reporting
206223
- Foundation error handling patterns
224+
- **Docs**: [simple_error_handling.md](../docs/examples/simple_error_handling.md)
207225

208226
36. **[simple_timeout_test.yaml](simple_timeout_test.yaml)** - Timeout Handling Test
209227
- Timeout configuration and handling
210228
- Time-bound operation management
211229
- Performance monitoring
230+
- **Docs**: [simple_timeout_test.md](../docs/examples/simple_timeout_test.md)
212231

213232
### 📁 File & Template Operations
214233
37. **[file_inclusion_demo.yaml](file_inclusion_demo.yaml)** - Dynamic File Inclusion
215234
- Runtime file inclusion and template processing
216235
- Dynamic content aggregation
217236
- File-based workflow composition
237+
- **Docs**: [file_inclusion_demo.md](../docs/examples/file_inclusion_demo.md)
218238

219239
### 🧪 Testing & Development
220240
38. **[test_simple_pipeline.yaml](test_simple_pipeline.yaml)** - Simple Pipeline Testing
221241
- Basic pipeline testing framework
222242
- Validation and verification patterns
223243
- Development and debugging support
244+
- **Docs**: [test_simple_pipeline.md](../docs/examples/test_simple_pipeline.md)
224245

225246
### 📋 Legacy & Backup Examples
226247
39. **[modular_analysis_pipeline_backup.yaml](modular_analysis_pipeline_backup.yaml)** - Modular Analysis Backup
227248
- Backup version of modular analysis pipeline
228249
- Alternative implementation approach
229250
- Development history preservation
251+
- **Docs**: [modular_analysis_pipeline_backup.md](../docs/examples/modular_analysis_pipeline_backup.md)
230252

231253
40. **[modular_analysis_pipeline_fixed.yaml](modular_analysis_pipeline_fixed.yaml)** - Fixed Modular Analysis
232254
- Corrected version of modular analysis pipeline
233255
- Bug fixes and improvements
234256
- Production-ready implementation
257+
- **Docs**: [modular_analysis_pipeline_fixed.md](../docs/examples/modular_analysis_pipeline_fixed.md)
235258

236259
41. **[original_research_report_pipeline.yaml](original_research_report_pipeline.yaml)** - Original Research Report
237260
- Original research pipeline implementation
238261
- Baseline research functionality
239262
- Reference implementation
263+
- **Docs**: [original_research_report_pipeline.md](../docs/examples/original_research_report_pipeline.md)
240264

241265
## Pipeline Categories Summary
242266

0 commit comments

Comments
 (0)