Onboarding Walkthrough
Complete the guided onboarding flow to set up your first docs site: create a project, connect GitHub, configure docs.json, and trigger your first build.
The 5 Steps
1
Start TrialJamdesk starts your 14-day free trial of the Pro plan at your first sign-in.
- Every feature is on
- Trial ends 14 days from activation
2
Create ProjectName your documentation project:
- Use a clear, descriptive name (e.g., "API Documentation", "User Guide")
- The name becomes part of your documentation site's URL
- Change the display name later in project settings
3
Connect GitHub & Create Starter DocsJamdesk creates a new GitHub repository from the Starter Template:
- Sample pages with realistic content and components
- Pre-configured
docs.jsonwith navigation and branding - OpenAPI spec example for API reference docs
- Ready to edit and push
4
Install CLIInstall the Jamdesk CLI for local development:
npm install -g jamdeskThis step is optional. Install the CLI anytime, or edit documentation directly on GitHub.
5
Start EditingEdit your documentation:
- Via CLI: Edit files locally with
jamdesk dev - Via GitHub: Edit
.mdxfiles directly in your repository - On Jamdesk: Some dashboard features available (depending on plan)
Each push to GitHub triggers a rebuild.
After Onboarding
Next, you can:
Troubleshooting
I skipped a step, can I go back?
Yes. Finish onboarding anytime from the onboarding card on your project dashboard.
I chose the wrong GitHub repo
Create a new project with the correct repository. Delete the old one anytime.
I need help during onboarding
Contact support.