Jamdesk Documentation logo

Your First Build

What happens after you connect a repo: build phases, the Deployments tab, and what to check if something fails.

Automatic Builds

Jamdesk starts your first build as soon as you connect a repository. Every later push to your connected branch triggers a new build.

Build Progress

Track your build in the dashboard:

1
Queued

Your build is waiting to start. Peak times can add a brief queue.

2
Cloning

Jamdesk pulls your repository content from GitHub.

3
Validating

Jamdesk checks your docs.json and MDX files for errors.

4
Building

Jamdesk compiles MDX to HTML with syntax highlighting and a search index.

5
Deploying

Built files upload to the global CDN.

6
Live

Your docs are available at your project URL.

Viewing Your Live Docs

Click View Site in the dashboard or visit https://your-project.jamdesk.app.

Your docs also appear on your custom domain, if you configured one.

Manual Rebuild

Rebuild without pushing changes:

  1. Go to your project in the dashboard
  2. Open Settings
  3. Click Rebuild

Use this after changing environment variables or to force a fresh build.

If Your Build Fails

The dashboard shows an error message for a failed build. Common causes:

  • Invalid docs.json syntax
  • MDX syntax errors
  • Missing pages referenced in navigation
Build Error Reference

See common error codes and how to fix them

Triggering Builds

Learn about automatic and manual build triggers

Monitoring Builds

Track build progress and view logs