Quickstart

1. Create the docs project

• Create a dedicated Vercel project named torra-docs.
• Set the project Root Directory to packages/docs.
• Keep this deployment separate from the public website project.
• Use the same Vercel team that already owns torra-website.

2. Bind the domain

• Add the production domain docs.torra.cloud to the new Vercel project.
• Because authoritative DNS is currently on HiChina, add the required DNS record there.
• Verify the domain resolves to the Vercel project before updating any public links.

3. Flip the website entry point

• Update the website environment variable NEXT_PUBLIC_DOCS_URL.
• Change it from the current fallback /docs to https://docs.torra.cloud.
• Redeploy the website after the docs domain is serving correctly.

4. Publish the first docs set

• Add MDX files under content/docs.
• Update content/docs/meta.json to control ordering.
• Use the docs package as the single source of truth for API, guide, and console documentation.

5. Initial information architecture

• Overview and architecture
• API and streaming reference
• Capability and file guides
• Integration playbooks
• Console operations manual

Local commands

pnpm dev:docs
pnpm lint:docs
pnpm typecheck:docs
pnpm build:docs