What problem does it solve?
This Skill consolidates Convex development guidelines into a coherent reference, helping teams build robust, typed, and maintainable Convex backends.
Core Features & Use Cases
- Function guidelines: Standardize function definitions using the new Convex function syntax, including proper argument and return validators.
- Validators & Schemas: Enforce strict validators, schema definitions, and type-safety for IDs and records.
- Api Design & Registration: Differentiate public vs internal functions and enforce safe usage patterns, with examples of queries, mutations, and actions.
- Pagination, Storage & Scheduling: Cover paginated queries, file storage guidelines, and scheduling patterns for background tasks.
- Guidelines Coverage: Includes TypeScript typings, code organization, and performance considerations for Convex apps.
- Real-world usage examples: How to structure Convex projects with schema.ts, generated API references, and typical file layouts.
Quick Start
Read this guide to structure your Convex project: create convex/index.ts with query/mutation definitions, define convex/schema.ts, and align your project layout with the examples provided.