Documentation Map

Use this page to jump to the right guide by role and task.

Choose Your Path

Path A: New User (10-20 minutes)

1. Quick Start
2. Usage Guide
3. Examples
4. Troubleshooting

Path B: Integrator (language bindings)

1. Usage Guide
2. API Surface
3. One binding guide:
   • Python Binding
   • Node.js / TypeScript Binding
   • Go Binding
4. Cross-Language Capability Matrix

Path C: Contributor / Maintainer

1. Development Guide
2. Architecture
3. Rust Core Systems
4. Documentation Standards
5. Contribution Checklist

Build and Operate

• First successful request: Quick Start
• Unified client patterns: Usage Guide
• Production examples: Examples
• Release workflow: Release Checklist
• Common failures: Troubleshooting

Workflow System

• YAML authoring and execution model: YAML Workflow System Guide
• Capability boundaries and contracts: Workflow Capability Contract
• Debugging and timeline inspection: Workflow Debugging UX
• Performance profiling and tuning: Workflow Performance
• Security and hardening controls: Workflow Security
• YAML/code migration guide: Workflow DSL Migration Cookbook

Architecture and Internals

• System architecture overview: Architecture
• Rust crate boundaries and source-of-truth logic: Rust Core Systems
• API inventory and shape map: API Surface
• Tracing model and telemetry correlation: Tracing Architecture

Fast Lookup

• Setup and commands: Development Guide
• First run path: Quick Start
• Provider/routing/streaming patterns: Usage Guide
• End-to-end snippets: Examples
• Binding entry points: Python, Node, Go
• Contract and parity checks: Capability Matrix
• Workflow incident debugging: Workflow Debugging UX
• Release readiness: Release Checklist