Contributing to the docs

Run locally

The documentation is a private Starlight project under docs/. Its dependencies and lockfile are separate from the library’s. Building the docs currently requires Node.js 22.22 or newer; the connector package’s own Node.js requirement is unchanged.

From the repository root:

pnpm install --frozen-lockfile
pnpm --dir docs install --frozen-lockfile
pnpm --dir docs dev

The first command installs the library dependencies needed to resolve its source and installed schema. The second installs the site tooling.

pnpm --dir docs check
pnpm --dir docs build

The content check verifies event, option, route, environment-variable, and public-client-member coverage, then type-checks the TypeScript snippets in authored pages. A production build generates the API and schema pages and validates internal links with Starlight Links Validator.

Where to edit

• Write guides and event explanations in docs/src/content/docs/.
• Edit public API comments at the source declaration so generated reference pages and editor hints agree.
• api/ and schema/ inside the content directory are generated and ignored. Do not hand-edit or commit them.
• Keep the generated protobuf reference tied to the installed tiktok-live-proto dependency. Do not copy an unrelated schema into the docs.

The event index and grouped references are authored Markdown. When adding or renaming an event, update its enum name, listener string, payload type, and explanation. The coverage check catches omissions; it cannot verify every sentence’s meaning.

Verify behavior

Read the implementation and its tests before describing behavior. Type definitions establish available fields, while dispatch code establishes which named event is emitted. For an uncertain protocol field, describe the known structure and clearly state the limit of its interpretation.

Use short, complete TypeScript examples in ts or typescript code fences. They are compiled as separate modules against the current source, not executed against live streams. Shell commands use sh fences. Historical examples that intentionally use an old API should be explained as such rather than added as passing current examples.

Use synthetic or sanitized data in fixtures. Replaying a fixture verifies decoding and dispatch; it does not prove delivery timing, account eligibility, or every live cohost arrangement.

Deployment

The documentation workflow validates pull requests and uploads the static site as a review artifact. Pushes to ts-rewrite also deploy the site to Cloudflare Workers at https://ttlc.docs.isaackogan.com/ when the repository has the Cloudflare secrets. See Cloudflare Workers hosting for the Worker configuration, the secrets, and how to deploy from a checkout.

DOCS_SITE sets the public origin and defaults to the custom domain. DOCS_BASE sets the deployment subpath and defaults to /. Neither needs to be set for a normal build.