AI-SDLC Documentation
User-facing documentation for the AI-SDLC Framework.
Source of truth. This repository is the canonical source for all user-facing documentation. The published site at
ai-sdlc-iobuilds from this repository at a pinned commit; it does not hold its own copy. Always edit here, never inai-sdlc-io. Seebacklog/decisions/AISDLC-68-documentation-consolidation.mdfor the original architecture decision.
Sections
| Section | Description |
|---|---|
| Getting Started | Installation, CLI quick start, first pipeline |
| Tutorials | Step-by-step walkthroughs (5 tutorials) |
| API Reference | Complete SDK and orchestrator reference |
| Examples | Runnable TypeScript and YAML examples |
| Architecture | Package structure, data flow, design decisions |
| Operations | Operator runbooks, execution paths, and production triage — see Operations index for the full navigation map |
| Troubleshooting | FAQ, common errors, environment variables |
Quick Links
- New to AI-SDLC? Start with Getting Started for installation and CLI quick start.
- Configuring agent runners? See the Runners Reference for all supported agents.
- Building with the SDK? See the API Reference for types, functions, and examples.
- Learning the concepts? Read the Primer for a conceptual introduction.
- Implementing a spec? The Specification contains the full normative requirements.
For Spec Contributors
The normative specification lives in spec/. These docs are informative guides aimed at implementors and end users.
License
Apache-2.0