These pages use a handful of core terms consistently. This page defines each one.
Orgs¶⎘
An org is the top-level account container. Everything belongs to an org--workspaces, docs, tokens, and settings. An org corresponds to a single account on the service.
Workspaces¶⎘
A workspace is a named collection of docs within an org. Workspaces let you group related content--a team's runbooks, a project's specs, a personal notebook--without mixing them together. A single org can have multiple workspaces.
Docs¶⎘
A doc is a single markdown file in a workspace. Each doc is identified by a 26-character
Crockford Base32 ULID, like
01KRP92RKSM5DFVKYAJHEWYSA4. The ULID appears in the doc's URL and in the doc_id
field returned by the API and CLI. Within a workspace, docs also have a path--a
slash-separated string like guides/quickstart--that acts as a stable human-readable
name. Paths are unique per workspace.
Versions¶⎘
Every time a doc is written, a new version snapshot is created. Older versions remain readable; they are not overwritten or discarded. The most recent version is served by default. Versions are identified by a monotonically increasing sequence number scoped to the doc.
Share tokens¶⎘
A share token grants anonymous read access to a single doc. Any authenticated user can create a share token for a doc they can read; revoking the token immediately removes access. Share tokens are separate from API tokens and carry no write permissions.
See Sharing for the share-link UX and URL format.