Documentation
Orkeon Code's documentation, published as a browsable site at https://orkeon.github.io/orkeon-code/. Start with Getting started; the README gives the tour. The same pages exist in French.
| Getting started | Docker, tool and source modes, first session |
| WSL tutorial | Speech and a local model on WSL2, on the GPU, step by step |
| Configuration | LLM providers, settings file, environment variables |
| Permissions | Modes, rules, what the agent can touch |
| Hooks | Your commands around the model's tool calls in the dev steps |
| Shared memory | Admitted decisions, structures, methods and mistakes the agents recall |
| Slash commands | The full list (generated) |
| Architecture | Layers, ports, crews, the loop, prompt assembly, recipes |
| Autonomous and embedded runs | Unattended turns, one-shot runs, schedulers and CI, your application |
| Extending | Commands, crews, tools, prompts, modes, your own directories, the limits |
| Development | Tests, checks, typings, upgrading Orkeon, releasing |
| Roadmap | What is missing and what comes next |
Decisions are recorded as ADRs: 0001 — ports, adapters and entry points, 0002 — Orkeon 1.0.0-rc.6 only, 0003 — prompts from a behaviour specification, 0004 — Orkeon main after #180, on the rc.6 pin, 0005 — Orkeon main after #206, on the rc.6 pin, 0006 — Orkeon main after #213, on the rc.6 pin, 0007 — Orkeon main after #217, on the rc.6 pin, 0008 — Orkeon main after #223, on the rc.6 pin, 0009 — Orkeon main after #230, on the rc.6 pin, 0010 — Orkeon main after #234, on the rc.6 pin, now a release, 0011 — the gates of an unattended run, and five dev commands instead of eight, 0012 — Orkeon main after #239, the exclusive crew launch, 0013 — the pin is a commit of Orkeon's main, never a release, 0014 — Orkeon main after #244, effort levels, a parallel index and an index cache.