Content
90%Weight 40%Scale 1-5Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.
A dense, highly actionable reference that communicates only non-obvious Convex rules with executable examples and strong mistake/checklist coverage. The main gaps are the absence of an explicit validate-and-fix feedback loop for database-touching code and no use of reference files to offload the longer tables and examples.
Suggestions
Add an explicit validation step to the workflow (e.g., 'After writing or changing a function, run `npx convex dev` so the generated types and validators are checked before finishing') to close the feedback-loop gap for database-touching mutations.
Move the Common mistakes table and/or the extended notifySubscribers example into a references/ file (e.g., references/common-mistakes.md), keeping the top mistakes inline and linking out, to reduce the single-file footprint.
Consolidate the terminal-method and write-method tables into one reference section or file so the reading and writing guidance share a single lookup point.
| Dimension | Reasoning | Score |
|---|---|---|
Conciseness | The body is lean and states only Convex-specific, non-obvious rules ('Never call .filter() on a table query', 'a public reference there skips the auth checks', '"use node" only in files that export actions') with no padding or explanation of concepts Claude already knows, matching the 5 anchor's 'every token earns its place'. | 5 / 5 |
Actionability | Every section provides complete, copy-paste-ready TypeScript covering the common cases (queries with withIndex, mutations with patch, internal scheduling, actions with runQuery/runMutation, ConvexError, thin wrappers), plus concrete method and mistake-to-fix tables, matching the 5 anchor. | 5 / 5 |
Workflow Clarity | The decision flow is clear (pick type by what the handler touches, then method tables, then a checklist) and the final Checklist section gives explicit verification checkpoints, but since mutations are database operations there is no run-time validation loop (e.g., type-check the result with the Convex toolchain before finishing), leaving it at 4 rather than 5's explicit validate-fix-retry feedback. | 4 / 5 |
Progressive Disclosure | Sections are well-organized with a one-level-deep Docs link list, but the ~270-line body inlines everything (the Common mistakes table, terminal-method reference, and extended examples) with no reference files to split into, which is good structure with minor organization gaps — the 4 anchor. | 4 / 5 |
Total | 18 / 20 Passed |