Docs Path Configuration

The documentation path tells Guidebook Cloud where your documentation files are located within your GitHub repository.

Auto-Detection

When you select a GitHub repository, Guidebook Cloud automatically searches for a book.json file and suggests it as the default docs path.

How It Works

  1. Search the repository for a book.json file
  2. If found, suggest its directory as the docs path
  3. If multiple book.json files exist, prefer the one closest to the repository root

Detection Examples

book.json LocationDetected Path
book.json/ (root)
docs/book.jsondocs/
packages/docs/book.jsonpackages/docs/

Setting the Docs Path

Configure the docs path when importing a repository or in repository settings. If a book.json file was detected, its path is pre-filled — you can still edit it before importing.

Common Patterns

PathDescription
/Documentation at repository root
docs/Documentation in a docs folder
jp/Japanese documentation folder
en/English documentation folder
packages/docs/Documentation in a monorepo

Required Files

Your documentation directory must contain:

SUMMARY.md

Defines the table of contents for your documentation:

# Summary

* [Introduction](README.md)
* [Getting Started](getting-started.md)
* [Configuration](config.md)

README.md

The main page of your documentation, displayed when users access the root URL.

Monorepo Support

For monorepos with multiple documentation directories:

Single Language

If your documentation is in a subdirectory:

my-repo/
├── packages/
│   ├── core/
│   └── cli/
└── docs/           <- Set docs path to "docs/"
    ├── SUMMARY.md
    └── README.md

Multiple Languages

For multi-language documentation, create separate repositories for each language:

my-repo/
├── docs/
│   ├── en/         <- Repository 1: docs path "docs/en/"
│   │   ├── SUMMARY.md
│   │   └── README.md
│   └── ja/         <- Repository 2: docs path "docs/ja/"
│       ├── SUMMARY.md
│       └── README.md

Changing the Docs Path

To change the docs path for an existing repository:

  1. Go to Repository Settings
  2. Under GitHub Connection, update the Documentation Path
  3. Click Save Settings
  4. A new build will start with the updated path

Troubleshooting

Build Fails: SUMMARY.md Not Found

  • Verify the docs path is correct
  • Ensure SUMMARY.md exists in the specified directory
  • Check file name case sensitivity (must be SUMMARY.md)

Wrong Content Displayed

  • Verify the docs path points to the correct directory
  • Check that README.md exists in the docs path
  • Rebuild the documentation after updating the path