convex-doc

Enforce consistent Convex documentation rules for convex.mdc and convex-*.mdc files.

434|33|Updated Jul 27, 2025
One-click install
npx skills add https://github.com/udecode/better-convex --skill convex-doc
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: convex-doc
Source: https://github.com/udecode/better-convex/tree/main/.claude/skills/convex-doc
Command: npx skills add https://github.com/udecode/better-convex --skill convex-doc

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Convex documentation often lacks consistent guidelines; this skill provides rules and patterns to keep convex.mdc and convex-*.mdc files aligned and maintainable.

Core Features & Use Cases

  • Establishes content guidelines for Convex MDC files.
  • Provides context optimization principles and clear usage-vs-setup separation patterns.
  • Enables consistent documentation updates across teams.

Quick Start

Consult and apply the convex documentation rules to update convex.mdc and convex-*.mdc files in your project.

Frequently Asked Questions about convex-doc

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

FAQPage Schema
How do I enforce consistent rules for Convex documentation files across multiple projects?

You can enforce consistent Convex documentation by applying predefined rules and patterns to convex.mdc and convex-*.mdc files, ensuring content guidelines and context optimization remain aligned across all repositories.

What are the best practices for separating usage and setup instructions in MDC files?

Best practices for MDC files involve applying context optimization principles to clearly separate usage instructions from setup configurations, maintaining maintainable and consistent documentation templates across teams.

How do I update Convex MDC documentation templates without breaking existing context?

Update Convex MDC documentation by applying metadata-driven instructions and frontmatter-defined names, which guide editors through template changes while preserving context-aware guidance and existing file alignment.

Can I use frontmatter metadata to control how Convex documentation rules are applied?

Yes, Convex documentation rules can be controlled using frontmatter-defined names and a minimal activation body, allowing editors to satisfy metadata-driven instructions dynamically within documentation workflows.

Why does my Convex documentation lack consistent guidelines across team repositories?

Convex documentation lacks consistency when teams do not apply standardized rules and patterns to convex.mdc files, which this skill resolves by establishing content guidelines and context optimization principles.

What is the best way to maintain context-aware guidance in Convex MDC files?

The best way to maintain context-aware guidance is to apply consistent documentation rules that enforce clear usage-vs-setup separation patterns and context optimization principles within convex MDC files.