Skip to main content
DEV MODE
Running from branch dev

Documentation

Browse system documentation and architecture references.

Index

index.md

Documentation Orientation

This documentation set is organized to help you move from system intent to execution.

What This Covers

  • getting-started.md: what the system does and the operational flow from structure to portfolio to operations.
  • architecture.md: technical architecture, network edges, routing, and service boundaries.
  • supervisor/index.md: supervisor control usage and command reference for yarn ctl.
  • Existing docs in this directory: focused deep dives and reference material.

How to Read This

  1. Start with Getting Started to understand the operational model.
  2. Continue with Architecture to understand how the model is implemented.
  3. Use Supervisor Control for runtime control and logs.
  4. Use the sidebar tree in the /docs route to move between documents quickly.

Source of Truth

These files are read directly from ./docs and rendered in the application docs view.

If you update markdown here, the docs UI reflects that content through the docs API endpoints.