Project documentation
The rest of this book is for people who build, review, or audit Xianyun. It’s the same material that lives under docs/ in the Go-era layout, reorganised for the Rust workspace.
| Page | What’s in it |
|---|---|
| Vision | Where the project is headed and what “agent-first” means in practice |
| Architecture | The crate layout and the patterns the code follows |
| Testing | The unit suite and the NixOS VM tests |
| macOS | The macOS build host and the macOS-only code |
| Architecture decision records | Why the code is built the way it is |
| Specification | Requirements, with their status and the known gaps |
| User stories | Behaviour, written as testable scenarios |
| Threat model | What can go wrong, scored, with the evidence |
| Documentation review | The state of the documentation, and what’s left |
| Building the documentation | How this book and the API reference are built |
The artifacts cross-reference each other by identifier: ADR-NNNN, FR-, NFR-, IR-, and SR- for requirements, TM-<AREA>-NNN for threats, GAP-NNN for known gaps, and STORY-NNN for stories.