Authority
The manual is the creator front door. It is not a second specification. If a manual page and an accepted ADR disagree, follow the ADR and fix the manual.
Order
- Accepted ADRs in
docs/adr/ - Architecture and subsystem pages in
docs/ designdoc.htmlat the repository root- Accepted RFCs in
docs/rfc/ - Source contracts and tests
- Status notes and session reports
- Chat or a model's suggestion
An ADR outranks the founding document only for the decision it names, and only when it says what it supersedes. A research RFC is not production architecture. designdoc.html stays. Do not delete it because these pages exist.
The documentation map is the docs index. Decisions are indexed in the ADR index.
If a session is gone
Read in this order before changing the engine:
- This manual, so you know what a person can do in the editor.
docs/status/CURRENT.mdon disk. That file is the recovery log: what runs, what was last verified, and what must not be started. The generated site does not copy it, because it contains session measurements.docs/status/NEXT.mdfor the next constraint.- The subsystem page for the area you will touch, then the accepted ADRs that page names.
- The current source and tests for that subsystem.
Agents.mdat the repository root, for how a change is validated.
Then look at git status when you are in a clone that has commits. The private working tree at C:\JARVIG may have no commits of its own. The public source, when it has been published, is a separate tree. Publishing is a separate decision from writing docs. This manual does not authorize a push.
What the site includes
scripts/build-docs.ps1 turns the Markdown library into docs/site/. The site includes the manual, the editor, the architecture, the API, the ADRs, and the subsystem overviews.
It leaves these out on purpose:
| Left on disk | Why |
|---|---|
docs/status/ | Session logs and measurements. They are the recovery record, and they are not a creator tutorial. |
docs/BACKLOG.md | The ticket board, including harness names. |
docs/benchmarks/ | Measured runs. |
docs/rendering/microgeometry.md | The private surface rule. |
docs/research/aperiodic-detail.md | The same research, in note form. |
docs/rfc/RFC-0002-procedural-microgeometry.md | The unstamped proposal and its results. |
Those files remain in the repository. A link in the site that would have opened one of them is marked as repository-only. RFC-0002 stays proposed until a person accepts the look. Do not treat a manual page as that acceptance.
The rendered site in this repository is those pages. It does not include the session logs, the ticket board, the benchmark dumps, or the withheld procedural-detail notes. The manual chapters do not teach the private surface rule.
What a documentation change includes
A correction of a creator page updates the page, the docs index when the map changed, and docs/status/CURRENT.md when the change is the session's work. A new behavior still needs the engine change, a test, and the architecture page in the same change. A manual page that describes a click does not mark a ticket done.
Tickets the manual must not close
Character looks, terrain looks, and rendering experiments stay open until a person accepts the picture. The manual can tell you how to open the window. It does not stamp the ticket. Roadmap phases in ROADMAP.md are the sequence from the founding document. Later phases are not implied by the existence of this site.