Jamdesk Documentation logo

Deployment Workflow

Push to GitHub and your docs deploy automatically -- the workflow from local edits to a live site in minutes.

Jamdesk handles deployment automatically. Push to your connected GitHub branch and your docs go live within minutes.

CLI Deploy

You can also deploy directly from the terminal without pushing to GitHub. This is useful for quick iterations, testing changes, or projects not connected to a repo.

jamdesk login     # First time only
jamdesk deploy

The CLI packages your files, uploads them, and shows build progress live. Use --detach to queue the build and exit immediately.

CLI Deploy Guide

Full pipeline walkthrough, build phases, error reference, and troubleshooting

The Workflow

1
Make changes locally

Edit your MDX files and preview with jamdesk dev.

2
Push to GitHub

Commit and push to your connected branch:

git add .
git commit -m "Update authentication docs"
git push
3
Automatic deployment

Jamdesk detects your push, builds your docs, and deploys to the CDN. Most sites build in 30-90 seconds.

Deployment Status

Check status in the dashboard under Deployments:

StatusMeaning
BuildingBuild in progress
DeployedLive at your domain
FailedBuild error - check logs
QueuedWaiting for previous build

Manual Rebuild

Trigger a rebuild without pushing:

  1. Go to Settings in your project
  2. Click Rebuild

Use this when updating environment variables or fixing stuck builds.

Build Logs

When builds fail, check Deployments → click a deployment → view logs. Common issues:

  • Invalid MDX syntax
  • Missing images
  • Broken internal links
  • Configuration errors

Rollbacks

Revert to a previous version:

  1. Go to Deployments
  2. Find the deployment to restore
  3. Click Rollback

The previous version goes live immediately.

What's Next?

CLI Deploy

Deploy from the terminal without pushing to GitHub

Build & Deploy Lifecycle

Detailed build process, triggers, and environment variables

Custom Domains

Set up docs.yourdomain.com

CLI Overview

Local tooling and commands

Local Preview

Preview docs before pushing