Reference¶
The guides, generated from the repository's docs/ directory. Each page
below is a copy of the file it names, so a correction belongs in docs/ and never here.
| Guide | What it covers |
|---|---|
| ADR 0001: Keep the runtime small and capability-oriented | Architecture decision records, and the reason behind each refusal |
| ADR 0002: TOML configuration and a SQLAlchemy-based SQLite provider | Architecture decision records, and the reason behind each refusal |
| ADR 0003: Begin at version 0.0.0 and isolate experimental scope | Architecture decision records, and the reason behind each refusal |
| ADR 0004: Use Ollama as the first AI provider | Architecture decision records, and the reason behind each refusal |
| ADR 0005: Freeze the Phase 1 runtime contract | Architecture decision records, and the reason behind each refusal |
| ADR 0006: Keep the HTTP and database layers behind adapters | Architecture decision records, and the reason behind each refusal |
| ADR 0007: Trusted plugins as an explicit, ordered capability model | Architecture decision records, and the reason behind each refusal |
| ADR 0008: Name the in-process execution unit Workflow | Architecture decision records, and the reason behind each refusal |
| ADR 0009: Freeze the workflow engine contract | Architecture decision records, and the reason behind each refusal |
| ADR 0010: Freeze the AI facade contract | Architecture decision records, and the reason behind each refusal |
| ADR 0011: Freeze the durable executor contract | Architecture decision records, and the reason behind each refusal |
| ADR 0012: License the project under Apache-2.0 | Architecture decision records, and the reason behind each refusal |
| ADR 0013: Freeze the stable surface and its versioning rules | Architecture decision records, and the reason behind each refusal |
| ADR 0014: No identity, tenancy, or authorization model | Architecture decision records, and the reason behind each refusal |
| ADR 0015: Durability is single-host, and the worker role is the integration point | Architecture decision records, and the reason behind each refusal |
| ADR 0016: Database providers are an extension point, not a core feature | Architecture decision records, and the reason behind each refusal |
ADR 0017: Publish this line as xyberos 2.0.0 |
Architecture decision records, and the reason behind each refusal |
| AI guide | The provider-neutral AI facade, structured output, tools, and the Ollama adapter |
| Command-line guide | The four commands: new, check, run, and migrate |
| Database operations guide | Database operations with the shipped SQLite provider |
| Durable execution guide | Durable execution, and its stated non-guarantees |
| Getting started | Installation and the first application |
| HTTP guide | The Starlette-backed HTTP adapter |
| Performance baselines | The performance baselines |
| Plugin guide | The trusted plugin contract |
| Release guide | The release procedure and its preconditions |
| Runtime guide | Scopes, lifecycle, configuration, and the error taxonomy |
| Security guide | The security posture, and the one deployment failure mode that matters |
| Stability and versioning | Which surface is stable, preview, or experimental |
| Testing guide | Test doubles and how to test an application without a service |
| Troubleshooting guide | Diagnosing the errors the runtime raises |
| Where Xyberos fits | Who the framework is for, and who it is not for |
| Workflow guide | The in-process workflow engine |
| Writing a database provider | Writing a provider package that passes the conformance suite |
| Xyberos architecture — reviewer's guide | The architecture review |
| Xyberos implementation plan | The phase-by-phase implementation plan for this release |
| Xyberos tutorial | The tutorial that this site retires into the Fundamentals path |
| Xyberos — architecture baseline and roadmap |