Architecture

Architecture

This section is for people who work on Mesh.

The rule

Document here everything that cannot be understood by looking at a single code file.

If a reader can learn it by opening one file, put it in that file as a comment or type. If it spans files, records a choice, or explains why, it belongs here.

Areas

Area What belongs there
Roadmap What is planned, in what order, and what is done
Decisions One record per decision, in ADR format
Overview How the parts fit together, at a glance
In depth One page per subsystem or mechanism, in full
Research Investigations that fed decisions, with sources

To add or change a page, read Contributing to these docs.