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.
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.