Skip to content

Move docs hosting from GitBook to VitePress on Cloudflare Workers - #150

Merged
riglar merged 1 commit into
mainfrom
docs/move-off-gitbook
Nov 2, 2026
Merged

riglar merged 1 commit into
mainfrom
docs/move-off-gitbook

Conversation

@riglar

@riglar riglar commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

GitBook is locking down free accounts, so this moves the docs to VitePress on Cloudflare Workers (static assets, the devicecloud-docs Worker in the Moropo account).

Important

docs.devicecloud.dev already serves this branch. I switched the domain with a manual wrangler deploy. Please merge soon: until then, main is behind the live site, and the daily IP-address sync won't reach it.

What changed

  • Content stays in place. The 68 GitBook hints became ::: info / ::: warning, and the 4 tab groups became ::::tabs. The 4 screenshots moved to assets/ with alt text, and 2 unused images are deleted.
  • URLs are unchanged. SUMMARY.md still sets the sidebar, and it now also sets each page's URL the way GitBook did (/<section>/<title>). All 67 URLs from GitBook's sitemap return 200 on the new site.
  • Redirects live in public/_redirects and include the existing /cli-reference/mcp-server one. Redirects from repo paths (e.g. /cli/dcd-login) are generated at build time.
  • Link check: npm run check fails on any broken page link or #anchor. It runs on every PR.
  • Branding comes from devicecloud.dev: the dark top bar, wordmark, teal #0A506F, Inter and Fragment Mono, and the favicons and social image.
  • Deploys: .github/workflows/deploy.yml builds and checks PRs. It deploys on every push to main and after each IP sync. (That sync's commits use GITHUB_TOKEN, so they can't trigger workflows themselves.) It uses the CLOUDFLARE_API_TOKEN repo secret.
  • CONTRIBUTING.md covers local preview, adding pages, callouts and tabs.

For reviewers

  • Renaming a page title or section heading in SUMMARY.md now changes its URL. Add a line to public/_redirects when you do.
  • The workers.dev URL is off now that the custom domain is attached.
  • Rollback: re-add the DNS record docs CNAME da914f4c1d-hosting.gitbook.io (DNS only), and remove the Worker's custom domain.

Testing

  • npm run build and npm run check: all internal links and anchors pass across 66 pages.
  • Checked all 67 GitBook URLs, the redirects, the 404 page and the TLS certificate on docs.devicecloud.dev.
  • Screenshots in headless Chrome: light, dark and narrow widths.

🤖 Generated with Claude Code

GitBook is locking down free accounts. The docs are now a VitePress site
served by Workers static assets (the devicecloud-docs Worker), already live
at docs.devicecloud.dev.

- Content stays where it is. GitBook hints and tabs become VitePress
  containers; the four screenshots move to assets/ with alt text.
- SUMMARY.md still drives the sidebar, and now also each page's URL, using
  GitBook's scheme, so every existing URL keeps working.
- public/_redirects keeps the old redirects; repo-path redirects are
  generated at build time.
- scripts/check-links.mjs fails the build on a broken page link or #anchor.
- Branding (logo, colours, fonts, icons) from devicecloud.dev.
- deploy.yml builds and checks PRs, and deploys main and each IP sync.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@riglar
riglar merged commit a253482 into main Nov 2, 2026
3 checks passed
@riglar
riglar deleted the docs/move-off-gitbook branch November 2, 2026 13:07
finalerock44 added a commit that referenced this pull request Nov 2, 2026
main moved the docs from GitBook to VitePress (#150) after this branch was
cut. getting-started/devices-configuration.md conflicted in four places;
each resolves to this branch's text (iPhone 16 / iOS 26 default, iOS 17 and
the iPhone 16 Pros deprecated until 9 November, the three removed devices).
The three hint blocks this branch adds are converted from GitBook's
{% hint %} to VitePress's ::: containers. npm run build and npm run check
pass.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant