Skip to content

Architecture

These pages are for people working on Open Conduit itself, or anyone who wants to know exactly what it guarantees. To install and run it, start at What Open Conduit does.

Each page separates three kinds of material:

  • Current behaviour and guarantees. The opening and the body of every page describe the code as it is now: what the part does, what it promises and its current limits. A limit stated here is a real limit today.
  • Design decisions. Nine pages record a decision, numbered B01 to B09, with its rules and the reasons for them. Code and other pages cite these numbers. The decisions still hold unless the page says otherwise.
  • History. Where a page has a History section at the end, it records how that part was built: which delivery ticket (numbered like 02-04) added what, what each stage left out at the time, and the evidence runs made then. Those notes describe the code at the time, not current limitations.

Performance gathers the evidence on throughput, latency, contention and resource use, and names what has not been measured yet.

Pages here describe intended behaviour, not the code as it is. Each is rewritten to describe what was built when it lands, and the pages it changes are amended in the same change.

If a change alters behaviour a page describes, update the page in the same change: the opening and body must stay true of the code. Record when and why something changed in the page’s History section rather than in the body. The pages live in site/src/content/docs/architecture/, and make docs-check checks their example configs and commands like the rest of the site.