Skip to content

docs: clarify manual route grouping examples - #75

Merged
sam-bretz merged 5 commits into
mainfrom
sam/sdk-workflow-docs
Sep 28, 2026
Merged

sam-bretz merged 5 commits into
mainfrom
sam/sdk-workflow-docs

Conversation

@sam-bretz

@sam-bretz sam-bretz commented Sep 26, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

  • Make manual route grouping the primary SDK example entry point, with a path that says exactly what the example demonstrates.
  • Add an explicit route-grouping tree and route map showing how one trace becomes two dashboard workloads.
  • Move provider, framework, telemetry, execution, and fixture examples under clearly named integration categories.
  • Update READMEs, package-relative paths, CI jobs, and example tests for the new tree.
  • Preserve explicit route_source metadata from the earlier route workload change so developer-selected boundaries remain visible to classification.

Example tree

examples/
├── route-grouping/
│   └── content-generation/
│       └── one-trace-two-workloads/
│           ├── README.md
│           ├── main.py
│           └── routes/
│               ├── haiku-draft/README.md
│               └── haiku-review/README.md
├── integrations/
│   ├── providers/
│   ├── frameworks/vercel-ai/
│   └── telemetry/
├── execution/batch-first/
└── test-fixtures/fake-providers/

Validation

  • TypeScript SDK: 303 passed via npm test.
  • Python SDK: 494 passed, 2 skipped with the existing Google real-client test excluded because the installed local client bypassed its mock and attempted a live API request.
  • Relocated Python example contracts: 3 passed.
  • Relocated telemetry examples: 3 passed.
  • Offline manual route-grouping check: 3 calls, 2 routes, 1 trace.
  • OpenRouter and Vercel example package tests: passed offline.
  • git diff --check: clean.

Live Gemini and self-hosted validation were not run because deployment credentials were not available.

# Conflicts:
#	python/src/metergraph/_capture.py
#	python/src/metergraph/_context.py
#	typescript/src/capture.ts
#	typescript/src/context.ts
@sam-bretz sam-bretz changed the title docs: document explicit route workloads docs: organize examples by customer workflow Sep 26, 2026
@sam-bretz sam-bretz changed the title docs: organize examples by customer workflow docs: clarify manual route grouping examples Sep 28, 2026
@sam-bretz
sam-bretz merged commit 78a9959 into main Sep 28, 2026
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant