TeamGrid Developer Documentation

Source for developer.teamgridapp.com, covering API v1, legacy API v0, the TypeScript SDK, CLI, and optional read-only MCP server.

Use Node.js 22.14 through 24.

npm ci
npm run dev

Run every source, type, contract, build, and output check:

npm run verify

• The checked-in public/openapi/v1.json contract drives the API v1 reference.
• The checked-in public/openapi/v0.json contract describes the frozen v0 runtime.
• sources/contracts.json records contract provenance and SHA-256 digests.
• sources/sdk-reference.json, sources/cli-reference.json, and sources/mcp-reference.json pin the exact public client surfaces to the recorded TeamGrid/developer-platform commit.
• Historical v0 prose was migrated from ReadMe and retains source attribution in frontmatter.

scripts/sync-contracts.mjs and scripts/import-readme-v0.mjs are maintainer tools. They require the canonical local source repositories and are not part of a normal CI build. Synchronize contracts with npm run sync:contracts -- /path/to/teamgrid-api <full-contract-source-sha> <full-runtime-sha>; the command reads immutable Git objects rather than the API working tree. If the runtime SHA is omitted, it defaults to the contract source SHA for single-commit releases.

After building the pinned sibling developer-platform/developer-platform workspace, run npm run sync:packages and npm run sync:references to refresh the SDK, CLI, and MCP snapshots. Normal documentation CI runs npm run check:client-references without requiring sibling repositories; the scheduled drift workflow additionally reconstructs the references from source.

The site is a static Astro/Starlight build deployed to the teamgrid-developer-docs Cloudflare Pages project. Pull requests build and validate the complete site. A protected main push deploys that exact commit after the verification job succeeds, using the least-privilege credentials stored in the GitHub production environment.

The production domain is developer.teamgridapp.com. It was cut over to Cloudflare Pages on 2026-07-19. The *.pages.dev deployment URLs remain available for diagnostics and carry X-Robots-Tag: noindex so the custom domain is the only indexable origin.

See Production operations for deployment, smoke-test, and rollback procedures.

See CONTRIBUTING.md, SECURITY.md, and LICENSE.md.