Repositories

Repositories in Guidebook Cloud represent your documentation projects. Each repository is connected to a GitHub repository and automatically builds and deploys when you push changes.

Repository Concepts

Repository Slug

Each repository has a unique slug within your organization. This slug:

  • Is part of the documentation URL
  • Cannot be changed after creation
  • Is derived from the GitHub repository name when importing

Documentation URL

Your repository's documentation is available at:

https://guidebook.dev/{org-slug}/{repo-slug}/

Creating a Repository

Repositories are created by importing from GitHub:

  1. Go to Repositories
  2. Click New Repository
  3. Select a GitHub repository from the list
  4. Configure the documentation path
  5. Click Import

Repository Settings

Access repository settings by clicking the gear icon or Settings on the repository page.

General Settings

  • Repository Name - Display name (can be changed)
  • Default Branch - The branch shown when accessing the repository URL

GitHub Connection

  • View connected GitHub repository
  • Update documentation path
  • Configure auto-deploy settings

Deleting a Repository

To delete a repository:

  1. Go to Repository Settings
  2. Scroll to Danger Zone
  3. Click Delete Repository
  4. Confirm the deletion

Deleting a repository:

  • Removes all branches and build history
  • Disconnects from GitHub
  • Cannot be undone