Guides¶
Status: Placeholder. No guides yet — this directory exists as a forward-growth slot.
Guides are domain-specific tutorials that walk through a complete end-to-end use case for a particular framework, harness, or deployment context. Unlike Concepts (which explain the mental model) or How-to guides (which are short task-oriented recipes), guides are longer and opinionated: they say "here is one way to use Paxman for X".
When to add a guide¶
Add a guide when:
- You have a complete, end-to-end story that fits in 10-30 minutes of reading.
- The story is about using Paxman with something else (a framework, a runtime, a deployment target).
- The story is more than a how-to (which is a 5-minute recipe) and less than a concept (which is reference material).
Planned guides¶
| Guide | Status |
|---|---|
| Framework adapters (Django, FastAPI) | Planned (V1.1) |
| Agentic harness (LangChain, custom agent loops) | Planned (V1.1) |
| Embedded deployment (WASM, edge, on-prem) | Planned (V2) |
If you want to write a guide, open a PR that adds a new file in this directory and links it from the index above. The maintainer team will review the contribution.