Reference

The Reference section provides canonical documentation for every public surface a Foundry self-hoster interacts with: database schema, server functions, CLI commands, and environment variables.

Generated pages (Schema, Functions) are emitted by scripts/generate-reference.ts from convex/schema.ts and TSDoc comments on whitelisted Convex functions. They are regenerated on every docs build and marked with a <!-- DO NOT EDIT --> banner.

Hand-written pages (CLI, Environment Variables) are maintained directly in MDX.

Schema Reference Every Convex table, field, type, and index — generated from convex/schema.ts.

Functions Reference Whitelisted public queries, mutations, and actions with argument signatures.

CLI Commands Convex CLI commands for local development, deployment, and data management.

Environment Variables Every environment variable grouped by service, with required/optional status.