Documentation index for AI agents (llms.txt). Markdown versions of every page are available by appending .md to the page URL. The full corpus is at /llms-full.txt.

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 three 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.

Existing repository

Already have a Doccupine site in a repository? Choose Connect an existing repository to wire it up in place. Doccupine doesn't create a new repo or generate any content - it connects the one you have, sets up hosting, and installs the deploy webhook.

Your repo needs a doccupine.json file. Its location defines the root of the documentation project, so a site living in a subfolder of a larger repository works too - Doccupine builds from that folder.

You can connect your GitHub account at any time. If you're not sure, start with a managed repository - you can always migrate later.

Want the documentation written for you? Import from GitHub points the AI at any repository and generates a complete site instead of a starter one.

What happens during setup

After you choose a repository mode, Doccupine runs an automated setup process:

  1. Creates a GitHub repository
  2. Commits a starter template with example documentation files
  3. Creates a hosting project on the deployment platform
  4. Runs the initial build and deployment
  5. Sets up a webhook so future pushes to the main branch 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.

Platform Overview PreviousImport from GitHubNext
Back to HomeGitHubDiscord