ai files

[ianmacartney]

Summary by CodeRabbit

• Documentation

  • Added comprehensive guides for creating reusable backend components with isolated data and wrapper APIs.
  • Added step-by-step migration guides for safely evolving database schemas using validated deployment workflows.
  • Added performance audit workflow to diagnose and fix issues like slow queries, write conflicts, and subscription costs.
  • Added quickstart setup instructions for new Convex projects and existing apps.
  • Added authentication configuration guides for popular providers.
  • Added advanced patterns and reference documentation for optimization strategies.

• Chores

  • Added AI agent skill configurations enabling assisted development workflows.

[ianmacartney]

• fail steps with oversized return values instead of getting stuck #236
• ai files #235 👈 (View in Graphite)
• main

This stack of pull requests is managed by Graphite. Learn more about stacking.

[pkg-pr-new]

Open in StackBlitz

npm i https://pkg.pr.new/@convex-dev/workflow@235

commit: cd6d849

[coderabbitai]

Warning

Rate limit exceeded

@ianmacartney has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 12 minutes and 20 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 12 minutes and 20 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 55b12680-26cc-429c-861d-60fe9c0b927c

📥 Commits

Reviewing files that changed from the base of the PR and between 3f16af8 and cd6d849.

⛔ Files ignored due to path filters (7)

• .agents/skills/convex-create-component/assets/icon.svg is excluded by !**/*.svg
• .agents/skills/convex-migration-helper/assets/icon.svg is excluded by !**/*.svg
• .agents/skills/convex-performance-audit/assets/icon.svg is excluded by !**/*.svg
• .agents/skills/convex-quickstart/assets/icon.svg is excluded by !**/*.svg
• .agents/skills/convex-setup-auth/assets/icon.svg is excluded by !**/*.svg
• example/convex/_generated/ai/ai-files.state.json is excluded by !**/_generated/**
• example/convex/_generated/ai/guidelines.md is excluded by !**/_generated/**

📒 Files selected for processing (32)

• .agents/skills/convex-create-component/SKILL.md
• .agents/skills/convex-create-component/agents/openai.yaml
• .agents/skills/convex-create-component/references/advanced-patterns.md
• .agents/skills/convex-create-component/references/hybrid-components.md
• .agents/skills/convex-create-component/references/local-components.md
• .agents/skills/convex-create-component/references/packaged-components.md
• .agents/skills/convex-migration-helper/SKILL.md
• .agents/skills/convex-migration-helper/agents/openai.yaml
• .agents/skills/convex-migration-helper/references/migration-patterns.md
• .agents/skills/convex-migration-helper/references/migrations-component.md
• .agents/skills/convex-performance-audit/SKILL.md
• .agents/skills/convex-performance-audit/agents/openai.yaml
• .agents/skills/convex-performance-audit/references/function-budget.md
• .agents/skills/convex-performance-audit/references/hot-path-rules.md
• .agents/skills/convex-performance-audit/references/occ-conflicts.md
• .agents/skills/convex-performance-audit/references/subscription-cost.md
• .agents/skills/convex-quickstart/SKILL.md
• .agents/skills/convex-quickstart/agents/openai.yaml
• .agents/skills/convex-setup-auth/SKILL.md
• .agents/skills/convex-setup-auth/agents/openai.yaml
• .agents/skills/convex-setup-auth/references/auth0.md
• .agents/skills/convex-setup-auth/references/clerk.md
• .agents/skills/convex-setup-auth/references/convex-auth.md
• .agents/skills/convex-setup-auth/references/workos-authkit.md
• .claude/skills/convex-create-component
• .claude/skills/convex-migration-helper
• .claude/skills/convex-performance-audit
• .claude/skills/convex-quickstart
• .claude/skills/convex-setup-auth
• AGENTS.md
• CLAUDE.md
• skills-lock.json

📝 Walkthrough

Walkthrough

This PR introduces five comprehensive Convex agent skills with accompanying documentation and configuration. The skills cover component creation, schema migrations, performance optimization, project setup, and authentication. Supporting files include agent configurations, reference guides, and a skills lock file for version management.

Changes

Cohort / File(s)	Summary
Convex Create Component Skill .agents/skills/convex-create-component/SKILL.md, .agents/skills/convex-create-component/agents/openai.yaml, .agents/skills/convex-create-component/references/... (advanced-patterns.md, hybrid-components.md, local-components.md, packaged-components.md)	Added skill for designing and implementing Convex components with isolated tables and wrapper APIs. Includes decision tree for component shapes (local, packaged, hybrid), boundary rules, and reference patterns for callbacks, configuration, client wrappers, and advanced usage.
Convex Migration Helper Skill .agents/skills/convex-migration-helper/SKILL.md, .agents/skills/convex-migration-helper/agents/openai.yaml, .agents/skills/convex-migration-helper/references/... (migration-patterns.md, migrations-component.md)	Added skill for executing safe schema and data migrations using widen–migrate–narrow workflows. Includes guidance on common patterns (adding/deleting/changing fields, splitting nested data), dual-write/read strategies, and complete reference for the @convex-dev/migrations component.
Convex Performance Audit Skill .agents/skills/convex-performance-audit/SKILL.md, .agents/skills/convex-performance-audit/agents/openai.yaml, .agents/skills/convex-performance-audit/references/... (function-budget.md, hot-path-rules.md, occ-conflicts.md, subscription-cost.md)	Added skill for diagnosing and addressing performance issues via signal-driven workflow. Includes detailed reference guides for function budgets, hot-path optimization rules, OCC conflict resolution, and subscription cost mitigation.
Convex Quickstart Skill .agents/skills/convex-quickstart/SKILL.md, .agents/skills/convex-quickstart/agents/openai.yaml	Added skill for step-by-step Convex project setup. Covers both new projects and adding Convex to existing apps, with environment variable guidance and framework-specific wiring for React/Next.js.
Convex Setup Auth Skill .agents/skills/convex-setup-auth/SKILL.md, .agents/skills/convex-setup-auth/agents/openai.yaml, .agents/skills/convex-setup-auth/references/... (auth0.md, clerk.md, convex-auth.md, workos-authkit.md)	Added skill for implementing Convex authentication with multiple provider options (Auth0, Clerk, Convex Auth, WorkOS AuthKit). Includes provider-specific setup workflows, environment variable configuration, and validation steps.
Claude Skills Pointers .claude/skills/convex-create-component, .claude/skills/convex-migration-helper, .claude/skills/convex-performance-audit, .claude/skills/convex-quickstart, .claude/skills/convex-setup-auth	Added symlink-like references pointing to the corresponding agent skills under .agents/skills/.
Documentation & Configuration AGENTS.md, CLAUDE.md, skills-lock.json	Added project documentation files directing contributors to Convex guidelines and skill installation instructions. Added versioned lock file tracking five skills with source and hash information for deterministic resolution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~12 minutes

Suggested reviewers

• reeceyang

Poem

🐰 Five skills now flourish in the digital warren,
Components dance with schemas, migrations run true,
Performance tips whisper through indexed arrays,
Auth gates stand secure, quickstart pathways gleam,
A backend utopia—hop along, friend! 🌟

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch ian/ai-files

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}