Korrin documentation
Four kinds of documentation, each with a distinct job:
| Directory | Question it answers | Audience |
|---|---|---|
spec/ | What does Korrin do, exactly? | Language users; anyone implementing tooling. Normative. |
guide/ | How do I learn Korrin? | Newcomers. Prose, examples, informal. |
decisions/ | Why is Korrin like this? | Contributors; future maintainers. |
internals/ | How is the implementation built? | Contributors to the Rust code. |
API documentation for the korrin crate lives in the source as rustdoc; build it
with cargo doc --open.
Which should I read?
- Using the language:
guide/, thenspec/as a reference. - Hacking on the interpreter:
internals/architecture.md, then the rustdoc, withdecisions/open for the "why". - Proposing a change: the contribution guide in the repository, and ADR 0000 for how decisions are recorded.
The rule that ties them together
Code and docs are kept in agreement by CI, not by good intentions — see ADR 0002. Runnable spec examples are executed on every build; missing API docs fail the build; every ADR is checked for structure and linkage.