convex-development-guide
Comprehensive development guide for Convex, a reactive database with real-time updates. This skill contains guidelines for building full-stack web applications with Convex backend, including function syntax, schema definitions, validators, scheduling, file storage, and Convex Components integration. Designed for AI agents writing, reviewing, or refactoring Convex applications.
Comprehensive development guide for Convex, a reactive database with real-time updates. This skill contains guidelines for building full-stack web applications with Convex backend, including function syntax, schema definitions, validators, scheduling, file storage, and Convex Components integration. Designed for AI agents writing, reviewing, or refactoring Convex applications.
Convex Development Guide
Comprehensive guide for building applications with Convex, a reactive database with real-time updates. Contains detailed guidelines for Convex functions, schema, validators, scheduling, file storage, and integration with Convex Components.
When to Apply
Reference these guidelines when:
- Writing or modifying Convex functions (queries, mutations, actions)
- Defining or updating Convex schemas and indexes
- Implementing file storage with Convex storage
- Using Convex scheduling (crons, scheduler)
- Integrating Convex Components (ProseMirror, Presence, Resend)
- Setting up authentication with Convex Auth
- Implementing HTTP endpoints in Convex
Key Sections
Core Guidelines
- System Prompts - Role definition and general system instructions for Chef AI assistant
- Convex Guidelines - Comprehensive Convex development best practices
- Solution Constraints - Template usage and constraints
Platform-Specific
- OpenAI Guidelines - Instructions when using OpenAI models (conditional)
- Google Guidelines - Workflow when using Google (conditional)
Integration Guides
- OpenAI Proxy - Using bundled OpenAI tokens in Chef (conditional)
- Resend Proxy - Using bundled Resend email in Chef (conditional)
Component Documentation
- ProseMirror - Collaborative text editor component
- Presence - Live-updating user presence management
- Resend - Email sending component
Development Instructions
- Formatting - Code and message formatting rules
- Example Data - Guidelines for handling example data
- Secrets - Environment variable setup instructions
- Output - Tool usage and deployment instructions
How to Use
Read individual documentation files for detailed explanations and code examples:
convex-guidelines.md - Comprehensive Convex development guidelines
system.md - Role and general system prompts
solution-constraints.md - Template and constraint information
openai.md - OpenAI-specific instructions (conditional)
google.md - Google-specific workflow (conditional)
openai-proxy-guidelines.md - OpenAI proxy integration (conditional)
resend-proxy-guidelines.md - Resend proxy integration (conditional)
components/prosemirror.md - ProseMirror component documentation
components/presence.md - Presence component documentation
components/resend.md - Resend component documentation
formatting-instructions.md - Formatting rules
example-data-instructions.md - Example data handling
secrets-instructions.md - Environment variable setup
output-instructions.md - Tool usage instructions
Each file contains:
- Detailed explanations of concepts
- Code examples and best practices
- Integration patterns
- Common pitfalls and solutions
Full Compiled Document
For the complete guide with all sections expanded: AGENTS.md
You Might Also Like
Related Skills
zig-system-calls
Guides using bun.sys for system calls and file I/O in Zig. Use when implementing file operations instead of std.fs or std.posix.
oven-sh
bun-file-io
Use this when you are working on file operations like reading, writing, scanning, or deleting files. It summarizes the preferred file APIs and patterns used in this repo. It also notes when to use filesystem helpers for directories.
anomalyco
vector-index-tuning
Optimize vector index performance for latency, recall, and memory. Use when tuning HNSW parameters, selecting quantization strategies, or scaling vector search infrastructure.
wshobsonsimilarity-search-patterns
Implement efficient similarity search with vector databases. Use when building semantic search, implementing nearest neighbor queries, or optimizing retrieval performance.
wshobsondbt-transformation-patterns
Master dbt (data build tool) for analytics engineering with model organization, testing, documentation, and incremental strategies. Use when building data transformations, creating data models, or implementing analytics engineering best practices.
wshobsonevent-store-design
Design and implement event stores for event-sourced systems. Use when building event sourcing infrastructure, choosing event store technologies, or implementing event persistence patterns.
wshobson