Creating a Project
From your dashboard, click Create new project to get started. You'll name your project and choose how its Git repository is managed.
Repository modes
Doccupine needs a GitHub repository to store your documentation files. You have two options:
Managed repository
Choose Use managed repository and Doccupine creates and manages the GitHub repo for you under its own organization. This is the simplest option - no GitHub account required on your end.
User repository
Choose Connect to GitHub to link your own GitHub account via OAuth. Doccupine creates the repo in your account, giving you full ownership and direct access to the source files.
You can connect your GitHub account at any time. If you're not sure, start with a managed repository - you can always migrate later.
What happens during setup
After you choose a repository mode, Doccupine runs an automated setup process:
- Creates a GitHub repository
- Commits a starter template with example documentation files
- Creates a hosting project on the deployment platform
- Runs the initial build and deployment
- Sets up a webhook so future pushes to the
mainbranch trigger automatic deploys
This takes about a minute. Once complete, you're redirected to your new project's file explorer.
Your site is live immediately after setup. Visit it using the Visit button in the project header.
Project limits
The number of projects you can create depends on your plan:
- Pro - 1 project, up to 5 team members
- Enterprise - 6 projects, unlimited team members
If you've reached your limit, you'll see a prompt to upgrade your plan.