Kit documentation

If you are new to Kit, read Getting started first. After that, each page stands on its own.

Using Kit

• Getting started: install, run locally, make your first requests, and find your way around the project
• Authentication: session tokens, API keys, abilities, email verification, password reset and rate limits
• Building endpoints: make:endpoint and the six pieces of every endpoint
• Errors: problem details, raising your own, documenting and testing them
• HTTP standards: idempotency, pagination, ETags, partial updates, deprecation, request IDs and media types
• Localization: how the language is chosen, what is translated, adding a language
• Webhooks: the contract subscribers get, and adding events of your own

Shipping it

• API documentation: Scribe, the contract tests, and legible
• Security: what production requires, transport, CORS and audit logging
• Deployment: the Docker image, the worker and scheduler, and Octane-safe code
• Quality and CI: the checks, the workflows, and reviewing dependencies with Vet
• Configuration: every environment variable Kit adds

For coding agents

AGENTS.md holds the same rules, written as instructions for an agent working in the codebase. These pages explain why things are the way they are; that file tells the agent what to do.