Workspaces
A workspace is one docs site. Use separate workspaces for separate products, APIs, teams, or permission boundaries.
Create a workspace
- Open Admin > Settings > Workspaces.
- Select New workspace.
- Add a name and color.
- Save.
The workspace is available at:
/docs/{workspace}
Access mode
Set how a whole workspace is exposed in Admin > Settings > Publishing. Each workspace has one access mode:
- Public: anyone can read published public articles without signing in.
- Internal: members only. Signed-out visitors get a "sign in to view" prompt instead of a 404.
- Private: hidden entirely. Signed-out visitors get a 404 and cannot discover the workspace.
Locked, encrypted, archived, and unpublished pages stay hidden regardless of the mode.
A new workspace starts as Internal. The first-run setup of a new account asks who reads the first workspace. Choose Public docs to make that workspace Public and listed. Only published pages are public. Drafts and proposals stay private.
Sidebar
Use sidebar sections to group articles. Keep top-level sections task based:
- Quickstart
- Guides
- Reference
- Troubleshooting
Landing page
Each workspace has its own landing page with search, categories, popular links, and footer links. Use it to guide readers to the most common tasks.
Export a workspace
To keep a backup or to move your docs to another tool, export the workspace:
- Open Admin > Settings > Workspaces.
- Pick the workspace.
- In the Export card, select Download .zip.
The file holds every article and changelog entry as Markdown, the images that they use, and a manifest of your sidebar. Each changelog file starts with front matter for the title, tags, status, and date. An end-to-end encrypted article keeps its title and settings, but not its text.