Onboarding Walkthrough
Complete the 5-step onboarding to set up your first docs site
The 5 Steps
When you first sign in, Jamdesk automatically starts your 14-day free trial of the Pro plan.
- No credit card required
- Full access to all features
- Trial ends 14 days from activation
Give your documentation project a name:
- Use a clear, descriptive name (e.g., "API Documentation", "User Guide")
- This becomes part of your documentation site's URL
- You can change the display name later in project settings
Jamdesk 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 immediately
The Jamdesk CLI enables local development:
npm install -g jamdeskYou can skip this step during onboarding and install the CLI anytime. If you skip it, you can still edit documentation directly on GitHub.
You're ready to build! Edit 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)
Changes automatically trigger documentation rebuilds when you push to GitHub.
After Onboarding
Once you complete onboarding, you can:
Troubleshooting
I skipped a step, can I go back?
You can complete onboarding anytime from your project dashboard. Look for the onboarding card to continue where you left off.
I chose the wrong GitHub repo
Create a new project with the correct repository—you can delete the old one anytime.
I need help during onboarding
Contact support at any point during the process.