Publishing Changes
When you edit files in Doccupine, your changes are staged as pending. Nothing goes live until you explicitly publish.
The publish workflow
- Make edits to your files using the file editor.
- Click the Publish button in the project header. A badge shows the number of pending changes.
- Review the list of modified, deleted, and new files in the publish modal.
- Optionally write a custom commit message (defaults to "Update docs via Doccupine").
- Click Publish Changes.
Doccupine then:
- Commits all pending changes to your GitHub repository
- Triggers a new deployment
- Clears all pending changes from the staging area
The deployment status badge in the project header updates as your site builds. It cycles through queued, building, and ready (or error if something went wrong).
Discarding changes
If you want to undo your pending edits, click Discard All Changes in the publish modal. This removes all staged changes without committing anything.
File status badges
In the publish modal, each file shows a badge indicating what changed:
- mod - the file was modified
- del - the file was deleted
- bin - the file is a binary asset (image, font, etc.)
Auto-deploy from GitHub
If you're using a user-connected GitHub repository and push changes directly (outside of Doccupine), the webhook triggers an automatic redeploy. This means you can use Doccupine's editor and Git-based workflows interchangeably.