Share Mintlify docs for review

Mintlify's writing loop is good. Its review loop assumes everyone who needs to read a draft is inside your Mintlify project — which is true of your team and false of the customer, the security reviewer, and the partner whose API you just documented.

Publish the rendered pages

For a single page or section, render it and publish the file:

# any renderer that turns your MDX/markdown into standalone HTML
npx pandoc docs/api-reference/auth.mdx -o auth.html --standalone --embed-resources

For a built site, publish the output folder as a bundle:

cd dist && zip -qr ../docs.zip . && cd ..

curl -fsS -X POST https://commareports.com/api/v1/reports \
  -H "Authorization: Bearer $COMMA_API_TOKEN" \
  -F "title=Auth docs — draft 3" \
  -F "visibility=unlisted" \
  -F "bundle=@docs.zip"

--embed-resources on the single-file path keeps it self-contained, so it renders the same for someone who opens it on a locked-down network.

Why the review layer is the point

Docs review is the one workflow where the feedback must be attached to the sentence. A list of "page 3, second paragraph, wrong flag name" comments costs the writer more than the fix does.

  • Anchored threads — the correction sits on the sentence. See commenting on HTML.
  • Revisions at one URL — one report id per section, one revision per draft; reviewers keep using the same link.
  • Access per report — unlisted for an external reviewer, team-only for an internal draft, domain-gated for a customer's whole org. See the sharing model.

Close the loop with the agent

If an agent drafts the docs, it can read the review comments back through the MCP server and revise — let an agent respond to comments.

Limits

  • Entry HTML: 5 MB. Embedded images count; link large diagrams as assets instead of inlining them as data URIs.
  • Assets: 25 MB per file, 250 MB and 500 files per report.
  • 60 requests/minute per token.

Try it

Comma is free — unlimited reports, unlimited commenters, unlimited revision history.

Publish a docs draft →

Related