Summary
Add an examples/README.md that indexes and categorizes the example scripts (linear/DAG basics, caching/checkpointing, MCP, integrations, coding-agent, cost/observability, export) with one-line descriptions and the command to run each, so newcomers can find the right starting point.
Why this matters
The examples/ directory holds 30+ scripts flat at the root with no index, so a newcomer cannot tell simple_linear_flow.py from skdr_policy_eval_flow.py without opening each. A short categorized index is the lowest-cost onboarding improvement and complements the existing cookbook docs by pointing from the repo (where contributors land) to runnable code.
Current evidence
examples/ contains 30+ files (simple_linear_flow.py, etl_flow.py, caching.py, checkpoint_resume.py, mcp_*, coding_agent_*, export_openai_anthropic.py, otel_export.py, …) plus cookbook/, integrations/, release_readiness_flow/, weaver_stack_golden_path/ subdirs — and no examples/README.md.
docs/cookbook/ mirrors several examples but the repo-side examples/ has no map back to docs.
- The notebook CI lane (nbmake) and example-running already exist, so examples are maintained — they just lack discoverability.
External context
A categorized examples index is a near-universal convention in mature Python libraries' examples/ directories.
Proposed implementation
- Author
examples/README.md with sections (Basics, DAG & branching, Caching/Checkpointing, MCP, Integrations, Coding-agent, Cost & observability, Export, Weaver Stack) listing each script with a one-line purpose and run command.
- Link each entry to its cookbook page where one exists.
- Add a CI check (extend the existing examples lane) that fails if a
.py in examples/ root is missing from the index — keeping it from going stale.
AI-agent execution notes
Inspect examples/ (full listing), docs/cookbook/index.md for category language to reuse, the examples/notebook CI lane in .github/workflows/ci.yml. Keep descriptions factual and runnable; verify each listed command actually runs (the CI lane already runs many). The staleness check should enumerate examples/*.py and assert membership in the index.
Acceptance criteria
examples/README.md lists every root-level example with a one-line description and run command.
- A CI check fails when a new root example is not indexed.
- Entries link to cookbook pages where they exist.
Test plan
A small test/script (under scripts/ or the examples lane) asserting index completeness; manual render check on GitHub.
Documentation plan
examples/README.md (new), link from top-level README Quick Start/examples mention and from docs/cookbook/index.md.
Migration and compatibility notes
Not expected to require migration.
Risks and tradeoffs
Index can drift from reality — mitigated by the completeness check. Minimal maintenance cost.
Suggested labels
documentation, contributor-experience, good-first-ai-issue
Summary
Add an
examples/README.mdthat indexes and categorizes the example scripts (linear/DAG basics, caching/checkpointing, MCP, integrations, coding-agent, cost/observability, export) with one-line descriptions and the command to run each, so newcomers can find the right starting point.Why this matters
The
examples/directory holds 30+ scripts flat at the root with no index, so a newcomer cannot tellsimple_linear_flow.pyfromskdr_policy_eval_flow.pywithout opening each. A short categorized index is the lowest-cost onboarding improvement and complements the existing cookbook docs by pointing from the repo (where contributors land) to runnable code.Current evidence
examples/contains 30+ files (simple_linear_flow.py,etl_flow.py,caching.py,checkpoint_resume.py,mcp_*,coding_agent_*,export_openai_anthropic.py,otel_export.py, …) pluscookbook/,integrations/,release_readiness_flow/,weaver_stack_golden_path/subdirs — and noexamples/README.md.docs/cookbook/mirrors several examples but the repo-sideexamples/has no map back to docs.External context
A categorized examples index is a near-universal convention in mature Python libraries'
examples/directories.Proposed implementation
examples/README.mdwith sections (Basics, DAG & branching, Caching/Checkpointing, MCP, Integrations, Coding-agent, Cost & observability, Export, Weaver Stack) listing each script with a one-line purpose and run command..pyinexamples/root is missing from the index — keeping it from going stale.AI-agent execution notes
Inspect
examples/(full listing),docs/cookbook/index.mdfor category language to reuse, the examples/notebook CI lane in.github/workflows/ci.yml. Keep descriptions factual and runnable; verify each listed command actually runs (the CI lane already runs many). The staleness check should enumerateexamples/*.pyand assert membership in the index.Acceptance criteria
examples/README.mdlists every root-level example with a one-line description and run command.Test plan
A small test/script (under
scripts/or the examples lane) asserting index completeness; manual render check on GitHub.Documentation plan
examples/README.md(new), link from top-level READMEQuick Start/examples mention and fromdocs/cookbook/index.md.Migration and compatibility notes
Not expected to require migration.
Risks and tradeoffs
Index can drift from reality — mitigated by the completeness check. Minimal maintenance cost.
Suggested labels
documentation, contributor-experience, good-first-ai-issue