Deployments
What to know to Deploy
Deploying Your Documentation
To deploy changes to your documentation website:
- Navigate to the Editor page
- Make changes to your documentation files or website layout
- Click Save to save changes to storage
- Click Deploy to deploy your changes to the live website
The deploy button triggers a deployment of all current content in the editor to your documentation website.
File States
Files in the editor display different states to indicate their status:
- Modified - Orange dot (●) indicates unsaved changes
- Deployed - Green checkmark (✓) indicates the file is deployed and matches the live site
- Neither - No indicator means the file has been saved
Folders inherit state indicators from their contents. A folder shows modified if any nested file is modified, or deployed if all nested files are deployed.
Observing Deployments
The dashboard provides an overview of your documentation deployments, showing deployment history, status, and key metrics.
Deployment Overview
The dashboard displays information about your deployed documentation:
- Status badge - Shows current deployment state (Live, Building, or Failed)
- Last updated - Time of the most recent deployment
- Deployment URL - Live URL where your documentation is published
- Repository - GitHub repository linked to your documentation
- Branch - Production branch being deployed
The dashboard includes a live preview of your documentation when successfully deployed. If a deployment is building, you'll see a loading indicator. Failed deployments display an error state.
Activity History
Below the deployment overview, the activity history table shows all deployment events with:
- Status - Current state of each deployment
- Commit message - Description of changes from the associated commit
- Branch/Commit - Branch name and commit SHA
- Date - When the deployment occurred
Filter deployments by time range using the tabs (7d, 30d, 90d, or custom dates).