Skip to content

Deployment

The docs are a VitePress site published from docs/.vitepress/dist to the Cloudflare Pages project bakerstreet-index.

Local Build

bash
npm ci
npm run docs:generate
npm run docs:check
npm run docs:build

Preview the Cloudflare output locally with Wrangler:

bash
npm run docs:preview:cloudflare

Cloudflare Pages

wrangler.toml points Wrangler at the built docs directory:

toml
name = "bakerstreet-index"
pages_build_output_dir = "docs/.vitepress/dist"
compatibility_date = "2026-06-17"

Deploy from the local repository with:

bash
npm run docs:deploy:cloudflare

The script runs npm run docs:build and then uploads docs/.vitepress/dist:

bash
wrangler pages deploy docs/.vitepress/dist --project-name=bakerstreet-index --branch=main

GitHub Workflow

.github/workflows/docs-pages.yml publishes the docs on pushes to main and through manual workflow dispatch.

Required repository secrets:

SecretPurpose
CLOUDFLARE_ACCOUNT_IDCloudflare account that owns the Pages project.
CLOUDFLARE_API_TOKENAPI token with Pages deployment access for the project.

The workflow runs npm run docs:check before npm run docs:build so stale generated references, missing sidebar entries, missing descriptions, and broken local links fail before deployment.

Custom Domain

The production docs are intended to resolve at https://index.bakerstreet.tech/.

Cloudflare should have:

  • a Pages project named bakerstreet-index
  • a custom domain binding for index.bakerstreet.tech
  • a proxied DNS record that routes index.bakerstreet.tech to the Pages target

LLM Output

The VitePress build emits:

  • /llms.txt
  • /llms-full.txt
  • page-level Markdown files such as /mcp.md

Use the visible agent-readable links at the top of docs pages to inspect the Markdown and LLM bundles after deployment.

Built by Baker Street for evidence-backed company memory.