The canonical documentation for Cresco — a hierarchical, secure, multi-tenant distributed agent mesh — is published as a full site at https://crescoedge.github.io/quickstart/. This repository holds its source.
All project information lives there: architecture, every module/plugin, every callable action, both client libraries, configuration, operations, and the engineering design documents.
| 🚀 Getting Started | build, run a mesh, configure |
| 🏗️ Architecture | how the mesh works |
| 🔌 Modules & Plugins | every component |
| ⚙️ Plugin Actions | all 89 callable actions |
| 💻 Client Libraries | Java + Python SDKs |
| 🔐 Security & Multi-Tenancy | identity, isolation, roles |
Built with MkDocs + Material for MkDocs.
python3 -m venv .venv && source .venv/bin/activate
pip install mkdocs-material
mkdocs serve # live-reload dev server at http://127.0.0.1:8000
mkdocs build # render static HTML into ./sitedocs/
├── index.md # landing
├── getting-started/ # installation, quickstart, configuration
├── architecture/ # overview, messaging, dataplane, discovery,
│ # security, tenancy, health, metrics
├── plugins/ # one page per module (agent, library, controller,
│ # core, logger, repo, sysinfo, wsapi, stunnel)
├── api/ # plugin actions (89), library API, MsgEvent
├── clients/ # Java (clientlib) + Python (pycrescolib)
├── operations/ # deployment, testing
├── reference/ # configuration params (180+), glossary, design-doc index
└── design/ # the full engineering design documents
Navigation and theme are defined in mkdocs.yml.
Keep pages accurate to the source. When a subsystem changes, update its architecture page and, where
relevant, the design document under docs/design/. New features should be documented as flag-gated and
default-off, matching the codebase's convention.