ConvexDoc | A documentation generator for your convex apps
Hello World! I've been building something I think a lot of you will find useful — convex-doc, an open source documentation generator and interactive API tester for Convex deployments.
The idea is simple: point it at your Convex project, and it generates a full documentation site for all your functions — queries, mutations, actions, and HTTP actions — complete with your argument and return types rendered as readable TypeScript-style signatures.
The killer feature is the built-in function runner. When served locally, you can call your functions directly from the docs UI with custom params, no Postman or manual testing needed.
What it does today:
• Parses your backend modules to extract all your function metadata automatically
• Generates a static HTML site styled with a custom design system
• Renders arg/return validators as human-readable type signatures (not raw JSON)
• Groups functions by module with type badges (query / mutation / action / httpAction)
• Interactive function runner built in — run your functions right from the docs
I also built convex-typegen (Rust types from the Convex API) a while back, so this is the next piece of that tooling ecosystem.
Still early but it's working and I'd love feedback from people actually running large Convex apps. Would really appreciate a
if it looks useful!
Demo video - https://youtu.be/c7D967JJnHE?si=RixoFcy_0AgRM6_H
The idea is simple: point it at your Convex project, and it generates a full documentation site for all your functions — queries, mutations, actions, and HTTP actions — complete with your argument and return types rendered as readable TypeScript-style signatures.
The killer feature is the built-in function runner. When served locally, you can call your functions directly from the docs UI with custom params, no Postman or manual testing needed.
What it does today:
• Parses your backend modules to extract all your function metadata automatically
• Generates a static HTML site styled with a custom design system
• Renders arg/return validators as human-readable type signatures (not raw JSON)
• Groups functions by module with type badges (query / mutation / action / httpAction)
• Interactive function runner built in — run your functions right from the docs
I also built convex-typegen (Rust types from the Convex API) a while back, so this is the next piece of that tooling ecosystem.
Still early but it's working and I'd love feedback from people actually running large Convex apps. Would really appreciate a
if it looks useful!Demo video - https://youtu.be/c7D967JJnHE?si=RixoFcy_0AgRM6_H
Join the Convex Discord! Explore Convex, the backend platform that keeps your app in sync.
15,590Members
Resources
Recent Announcements
Similar Threads
Was this page helpful?
