convex-docs

Fetches version-current Convex documentation matched to the project's installed package versions.

Updated Sep 17, 2026
One-click install
npx skills add https://github.com/Tehzeeb07/CodeRush --skill convex-docs-tehzeeb07
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: convex-docs
Source: https://github.com/Tehzeeb07/CodeRush/tree/main/.agents/skills/convex-docs
Command: npx skills add https://github.com/Tehzeeb07/CodeRush --skill convex-docs-tehzeeb07

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Convex APIs, component exports, and CLI flags change between versions, and writing code from stale memory produces build errors and wrong API calls. This Skill pins the installed Convex version and fetches current documentation so generated code matches the actual package in the project. ## Core Features & Use Cases - Version Pinning: Reads the installed convex and @convex-dev/* component versions from package.json or node_modules before trusting any documentation. - Freshness Hierarchy: Uses a served docs tool or MCP search first, then fetches docs pages as markdown or pinned READMEs, falling back to general web search only as a last resort. - Ground-Truth Verification: Checks the installed package's exports and .d.ts files in node_modules to confirm an export or signature exists for the exact version in use. - Use Case: A build fails because a Convex component export 'should' exist but doesn't. Instead of guessing a different spelling, the Skill re-pins the version, fetches the current API, and corrects the code. ## Quick Start Check the installed Convex version and fetch the current docs for the component API I am about to use before writing any code.

Frequently Asked Questions about convex-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I check which Convex version my project uses?▼

Run `node -p "require('./node_modules/convex/package.json').version"` or read the version in package.json. Do the same for any `@convex-dev/*` components, since the documentation you trust must match these exact installed versions.

How do I get up-to-date Convex API documentation?▼

Use a served docs tool or MCP search_convex_docs if available, otherwise fetch the specific docs page from docs.convex.dev as markdown or the component's README at the pinned version. General web search is a last resort with unverified version accuracy.

Why does a Convex export fail even though the docs say it exists?▼

This is usually version skew between the documentation and your installed package. Check the component's package.json exports and .d.ts files in node_modules, which are the ground truth for your version, then re-fetch docs pinned to that version.

Can I rely on node_modules types instead of Convex docs?▼

Yes, the installed package's exports and .d.ts files are more authoritative than any doc page for your specific version. Use them to verify whether a component export or signature actually exists before writing code.

When should I fetch docs instead of writing Convex code from memory?▼

Fetch whenever currentness is in doubt: unfamiliar APIs, possibly renamed functions, new component exports, or changed CLI flags. Version skew is the largest source of wrong Convex code, so pin the version and fetch first.