in-app-gitbook-handbook

Place a docs.yaml at the repository root declaring the space mapping with content.directory pointing at your docs folder. Each mapped directory needs its own .gitbook.yaml, README.md, and SUMMARY.md, and must be fully self-contained since GitBook does not share assets between spaces.

Create three routes: docs.tsx for the layout with an Outlet, docs.index.tsx for /docs, and docs.$.tsx for nested slugs. Resolve the page from the pathname rather than splat parameter names, since those differ across TanStack Start versions.

No, GitBook does not share content or assets between mapped directories in site-wide Git Sync. Each space directory must be fully self-contained, so duplicate assets per space or reorganize the structure.

Relative links break silently when the hierarchy changes, such as pages moving one directory deeper or sibling pages being dropped. Copy files first preserving subpaths, then run a link audit script and fix every broken reference before writing new pages.

No, the GitBookIO/gitbook renderer is a published-site renderer, not the content layer. Cloning GitBook for docs purposes means creating a content space plus Git Sync, not vendoring that application into the product repo.