Documentation
TinyCld serves two audiences and the docs are split to match.
Operate
You want to run TinyCld for your team — set up a server, get a domain, manage users, back up your data.
- Install TinyCld — clone, boot, and run the first-time setup wizard.
Build
You want to write a package for TinyCld, or contribute to one of the existing ones. Packages are independent git repos that join an npm workspace as members.
- Getting started — the layout of the ecosystem, how the workspace, app shell, core, and feature packages relate, and how a fresh checkout runs without any features.
- Adding a package — bring an existing package into the workspace with
npx @tinycld/bootstrap --tooling --with <pkg>+npm install. - Creating a package — scaffold a new package from scratch with
npx @tinycld/bootstrap. - Anatomy of a package — every directory, manifest field, and file a package can contain.
- Tasks — how to do common things inside a package: query data, mutate, build forms, manage UI state.
- Internals and reference — the generator, Go server wiring, and exhaustive field/CLI tables.