Suite documentation

A local-first, collaborative canvas. A workspace owns its cards, boards are views of those cards, and every write is validated in @suite/graph.

Run Suite locally Open the app

Version 1.1.0

Tutorials2 pagesLearn by doing. One guided path to a first success.How-to11 pagesOne task at a time: test, deploy, operate, release, contribute.Reference13 pagesFacts to look up: the model, commands, limits, security boundary.Explanation1 pageWhy the product and the code are shaped this way.

Deploy a server2026-10-28One small instance, one Docker host, one app container, six SQLite stores on one volume, Caddy in front, Cloudflare in front of Caddy.
Operate a deployment2026-10-28Suite runs as a single Node process with six SQLite stores on one directory; there is no external database and no multi-replica mode.
Run Suite locally2026-10-28This tutorial takes a checkout to a working canvas in one browser. It is one path with nothing to decide. Variants such as the standalone bundle, custom ports…
Billing and licences2026-10-28Billing is @better-auth/stripe registered on the auth instance (ADR-0078). The plugin owns the Stripe customer, Checkout, the billing portal, the webhook, the…
Canvas2026-10-28apps/canvas/src/canvas turns the workspace document into a board you can point at: placements become nodes, edges become routes, and every gesture ends in one…
Capacity2026-10-28What one relay holds, what one more open room costs, and where the CPU stops keeping up. The numbers on this page are measured on this checkout by…
Coding conventions2026-10-28The rules as rules. The model they serve is architecture.md. The procedure that applies them is ../how-to/add-a-feature.md, and the gate is…
Data model2026-10-28This page does not cover how the canvas draws these records or how a share link is authenticated; architecture.md and security-model.md own those. It describes…
Editing2026-10-28How card text, fields, templates and reference chips are stored and edited; the document model underneath is in architecture.md.
Environment2026-10-28Every variable the relay reads, its default, and what it changes. apps/collab-server/src/config/config.ts parses them once at boot and refuses to start on a…
Glossary2026-10-28One definition per term, in the sense this repository uses it. The model behind them is architecture.md, and the code identifiers are listed beside each term.
Interface2026-10-28How the shell, the library, the panels, the styling surfaces and the command palette are assembled, and the focus, keyboard and theme rules they share; the…
Limits2026-10-28What one Suite instance accepts, and what happens at the boundary. The numbers below are read from the code that enforces them, so they cannot drift from the…
Runtime2026-10-28The browser process: boot order, persistence, the relay, sharing, and the diagnostics an operator can read. It does not cover the document model…
Security model2026-10-28Two credentials open a room: a session JWT for an account and a share token for a link. The owner key that used to be the third was deleted (ADR-0076), with no…
Your first workspace2026-10-28This tutorial creates a small workspace, adds cards, links two of them, and checks that the work survives a reload. Start the app first with Run Suite locally.
Add a feature2026-10-28The data flow fixes the order: the document package owns the shape, the workspace document owns the write, the snapshot store owns the read, and the component…
Architecture2026-10-28Suite is a local-first collaborative canvas. One Loro document per workspace is the source of truth, @suite/graph validates every write, and the React canvas…
Change the canvas2026-10-28Adding to the canvas means answering three questions before writing code: which layer owns the input, what the document records, and what peers see while the…
Change the data model2026-10-28A record change travels one path: schema, reader, writer, facade, then the tests that prove two clients still converge. Skipping the reader step is how a field…
Change the editor2026-10-28Add a node, a mark, a field renderer, a slash command or a mention action to the card editor, with the files each one touches and the tests that fail when it…
Contribute a change2026-10-28One change, from branch to merge. The coding standards are in reference/conventions.md, the repo map in AGENTS.md, and the local gate in test-and-verify.md.
Design direction2026-10-28Suite is a local-first canvas over a workspace of typed cards. One Loro document holds the whole workspace, the browser edits it offline, and a relay syncs it…
Import an Obsidian vault2026-10-28Importing a vault folder reads every note, tag, link and canvas into one workspace. The import runs once, as a single change, so undo takes it back whole.
Release and roll back2026-10-28A release is a tag, an image built from it on the host that serves it, the image id that identifies it, a smoke test against a host, and a rollback path. This…
Test and verify a change2026-10-28Suite runs three test runners: Vitest for the workspace projects, Playwright for end-to-end journeys, and node --test for @suite/billing, which sits outside…
Try the paid flow on this machine2026-10-28The whole product runs in five containers on one machine: the relay, the control plane, Postgres, Caddy, and the docs site. This page walks the parts that need…