DocsGuides

Workspaces

Each product is one space. Every repo with a .context/ folder is one, and you write nothing.

Edit on GitHub

One repo, one space

Canon reads the folder that holds your product repos. Each repo with a .context/context.yaml becomes a space, named after the repo. Its pages are the Markdown files under .context/ideas/, .context/features/ and .context/wiki/.

A monorepo is still one space. Split it into separate repos only when the parts ship as different products.

A repo with no pages yet

A repo with .context/context.yaml but no pages still shows as a space. Its home says how to start one:

$ canon init      # in the repo
$ pnpm sync       # in canon, to show it

Check the result

$ canon status    # canon version, config and check summary for this repo
$ canon check     # this repo against its standards