Everything you need.
Nothing you don't.
Forma is deliberately small. Every feature exists because a real team had a real problem. Nothing is here for the demo.
Docs that write themselves.
Forma parses your TypeScript interfaces, JSDoc annotations, and OpenAPI specs on every commit. The output is structured, readable documentation — no templates, no formatting choices, no writers needed.
- Supports TypeScript, JSDoc, OpenAPI 3.0/3.1, and GraphQL schemas
- Preserves all hand-written markdown in-between generated sections
- Detects deprecated endpoints and surfaces them with warnings
Release notes that
actually help.
Forma reads your git diff and writes changelogs in plain English. Not "fix: typo in variable name". Actual human-readable explanations of what changed and why it matters.
- Groups changes by type: breaking, feature, fix, internal
- Links each change to the relevant commit or PR
- Editable before publish — AI writes the draft, you approve it
auth.verify() method now returns a Promise. Callers using the synchronous return value will need to be updated.Common questions.
Does Forma work with private repos?
Yes. Forma uses GitHub/GitLab OAuth and only requests read access to your code. We never store your source files — we read them at build time and discard them.
What languages and frameworks does Forma support?
Today: TypeScript, JavaScript (with JSDoc), OpenAPI 3.x, and GraphQL. Python and Go are in beta. If your stack isn't listed, email us — we build to order.
Can I keep some docs hand-written?
Absolutely. Any markdown file you write manually is left untouched. Forma only generates content for the symbols it finds in your code. You can mix and match freely.
How long does a deploy take?
For most codebases, under 60 seconds from push to live. Large monorepos with 500+ exports take 2–3 minutes. We cache aggressively and only re-parse files that changed.
What happens if I cancel?
Your docs stay up for 30 days. After that, you can export everything as static HTML — you own your content. No hostage-ware.