How this project is built: its architecture and how its parts fit, the stack it runs on and where its source lives, and one document for each part that needs one.
- The architecture: the system as it stands, its actors, building blocks, interfaces and trust boundaries, from the Architecture Overview seed.
- The stack and the source: what the project is built with, and where each part of it lives.
- One folder per area:
backend/,benchmarks/,database/,infrastructure/,interface/andtesting/, as the fill-in standards lay them out. - Designs, plans and research:
designs/,plans/andresearch/, from the Technical Design, Implementation Plan and Research Log templates.
The fill-in standards in templates/technical/
copy out to the same path here, without templates/:
docs/templates/technical/backend/API-Design-Standards.md becomes
docs/technical/backend/API-Design-Standards.md.
Its documents are yours from the first commit: nothing upstream ever writes, moves or removes one. Only this README is ever updated from the template, when you run 🔄 Template Sync, and its log is redrawn from the files the folder holds.
| Entry | Purpose |
|---|---|
README.md |
This file. |
🗂️ Machined Indexes redraws this log after every push to the default branch, from each document's own frontmatter.
- Documentation index - every document this project keeps
- Template catalogue - every seed, and where each one is copied to
Write down what the code cannot say.
Built with ❤️ by the Engineering Team. Distributed under the terms in LICENSE.