Workspaces and projects
Understand the objects that organize Staleless.
Workspaces and projects
Section titled “Workspaces and projects”A workspace is the organization boundary. It owns people, roles, billing, projects, domains, security policy, and audit history.
A project is a documentation site within a workspace. It owns pages, navigation, branches, appearance, access policy, repository connection, analytics, and publication history.
Pages and parent sections
Section titled “Pages and parent sections”A page is a Markdown document with a title, description, and path. A parent section groups related child pages and should itself be useful and clickable.
Example:
- Design
- Foundations
- Components
- Accessibility
- API
- Authentication
- Endpoints
- Errors
Keep page changes and navigation changes together. A page missing from navigation is an orphan and should not be merged.
Branches
Section titled “Branches”The main branch is the published source of truth. A draft branch is isolated work based on a published revision. A connected Git repository supplies source history and can receive branch pushes and pull requests.