This is a portable brief on how this repository structures its plans, documentation, and readmes. It describes the system generically so it can seed any project; nothing below depends on this site, its stack, or its tooling. The goal of the system is that the repository is the project's memory. A contributor, an agent, or the owner returning after six months can resume work from the files alone, with no dependence on chat history or anyone's recollection.
The system has three layers plus an overflow file.
- A
./README.mdorientation file at the repository root tells a newcomer what the repository is, the rules that must never be broken, and where everything lives. In an agent-driven repository this is the agent instruction file; in a conventional one it is the root README or CONTRIBUTING file. - A
docs/folder holds the durable documentation: how each subsystem works and why it is shaped that way, how recurring processes run, and what was decided.