FAQ

Frequently asked questions about Guidebook Cloud.

General

What is Guidebook Cloud?

Guidebook Cloud is a managed documentation hosting service. It builds and deploys documentation from your GitHub repositories automatically when you push changes.

Is Guidebook Cloud compatible with GitBook/HonKit?

Yes. Guidebook Cloud uses Guidebook, which is a drop-in replacement for HonKit and GitBook. Your existing SUMMARY.md and markdown files work without modification.

What file format does Guidebook Cloud support?

Guidebook Cloud supports Markdown files with a SUMMARY.md for navigation. It is compatible with the GitBook/HonKit format.

GitHub Integration

Why can't I see my GitHub repositories?

Make sure you have:

  1. Installed the Guidebook Cloud GitHub App on your account/organization
  2. Granted access to the repositories you want to import
  3. Refreshed the repository list

Can I connect multiple GitHub accounts?

Yes. You can install the GitHub App on multiple accounts and organizations. Go to Settings > GitHub Integration > Add Another Account.

How do I add access to more repositories?

  1. Go to your GitHub App installation settings
  2. Modify repository access to include additional repositories
  3. Return to Guidebook Cloud and refresh the repository list

What happens if I revoke GitHub access?

  • Automatic deployments stop working
  • Existing documentation remains accessible
  • You can reconnect at any time

Builds

Why did my build fail?

Common reasons for build failures:

  • SUMMARY.md not found - Check the docs path configuration
  • Invalid markdown - Syntax errors in your markdown files
  • Timeout - Build took too long

View the build logs for detailed error messages.

How long do builds take?

Most builds complete within 1-2 minutes. Large documentation sites may take longer.

Can I trigger a manual build?

Currently, builds are triggered automatically by:

  • GitHub push events
  • Importing a repository
  • Reconnecting GitHub

Access Control

How do I restrict access to my documentation?

Use access rules to restrict access:

  1. IP Allowlist - Restrict by IP address or CIDR range
  2. Repository-specific - Configure custom rules per repository

Can I make documentation public?

Yes. If no access rules are configured, documentation is publicly accessible to anyone with the URL.

What happens when access is denied?

Users see an access denied message.

Teams and Members

What's the difference between teams and roles?

  • Roles determine what actions a user can perform (Owner, Admin, Member)
  • Teams determine which repositories a user can access

How does Member access work?

Members have view-only access and can only see repositories and teams they are assigned to via team membership. To grant a Member access to specific repositories, add them to a team that has access to those repositories.

How do I transfer organization ownership?

Ownership transfer is not currently supported.

URLs and Access

What is the URL format for documentation?

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

For branches:

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

Can I use a custom domain?

Custom domains are not currently supported. Documentation is served from guidebook.dev.

Is there a subdomain for each organization?

No. All documentation is served from the main guidebook.dev domain with the organization slug as part of the path.

Troubleshooting

Documentation shows old content

  1. Check if the latest build succeeded
  2. Clear your browser cache
  3. Verify you are viewing the correct branch

I can't access the console

  1. Verify you have an account
  2. Check if you are a member of the organization
  3. Try logging out and back in

GitHub webhook is not working

  1. Verify the GitHub App is still installed
  2. Check the repository's webhook settings in GitHub
  3. Reconnect the repository in Guidebook Cloud