Getting Started

This guide walks you through setting up Guidebook Cloud for your team.

Sign Up

  1. Visit console.guidebook.dev
  2. Click Sign Up or Log In
  3. Authenticate using your email or SSO provider

Create an Organization

After signing in, you will be prompted to create your first organization.

  1. Enter an Organization Name (e.g., "My Company")
  2. Enter an Organization Slug (e.g., "my-company")
    • This will be part of your documentation URL
    • Use lowercase letters, numbers, and hyphens only
    • Cannot be changed after creation
  3. Click Create Organization

Install the GitHub App

To import repositories from GitHub, you need to install the Guidebook Cloud GitHub App.

  1. Go to Settings > GitHub Integration
  2. Click Install GitHub App
  3. Select the GitHub account or organization to install on
  4. Choose which repositories to grant access to:
    • All repositories - Access to all current and future repositories
    • Only select repositories - Choose specific repositories
  5. Click Install

You will be redirected back to Guidebook Cloud after installation.

Import Your First Repository

Once the GitHub App is installed:

  1. Go to Repositories > New Repository
  2. You will see a list of available GitHub repositories
  3. Click Import on the repository you want to add
  4. Configure the import:
    • Documentation Path - Where your docs are located (e.g., /, docs/, jp/)
  5. Click Import

The repository will be created and an initial build will start automatically.

View Your Documentation

After the build completes:

  1. Go to the repository details page
  2. Click View Documentation or navigate directly to: 
    https://guidebook.dev/{org-slug}/{repo-slug}/

Next Steps