Revdoku documentation

This repository is the one source of the Revdoku documentation at docs.revdoku.com: the guides, the API reference and the SDK, MCP and CLI guides. No other repository has a copy to edit. Revdoku publishes this repository as a docs site. Each push to main publishes the site again. A preview of another branch is made on request (New preview on the bucket's Overview) and lasts 24 hours. The commit gets a "Revdoku preview" status with the preview link, which a pull request shows with its checks.

Layout

Path	Contents	Change it
docs.json	Navigation, header, footer, page menu and redirects, in the Mintlify docs.json format.	Here
index.mdx, quickstart.md, docs-sites.md, coding-agents.md, support.md, buckets.md, api.md, mcp.md, guides/	Pages. Each page starts with front matter: title, description and an optional sidebarTitle.	Here
changelog.md	The public changelog. It starts with an H1 and has no front matter, because the release check reads that format. It is high level only: what a person can do now, never how Revdoku works. Add the entry of a release after the release is live.	Here
examples/	Runnable JavaScript, TypeScript and Python examples with their checks.	Here
openapi.json	The OpenAPI document of the Revdoku API. The API console and the reference read it.	Generated
api-reference/	One page for each resource of the API, and index.md with every operation.	Generated
sdks/	The TypeScript and Python SDK guides.	Generated
cli.md	The CLI guide.	Generated

Generated files

Do not edit openapi.json, api-reference/, sdks/ or cli.md by hand. The Revdoku application generates them:

File	Generated from
openapi.json	The OpenAPI document of the API.
api-reference/	The OpenAPI document, with the SDK call of each operation.
sdks/typescript.md, sdks/python.md	The READMEs of the revdoku packages on npm and PyPI.
cli.md	The README of the revdoku command-line tool.

The next generation replaces a change that you make in these files. To change one of them, change its source in the application.

Edit a page

1. Edit the Markdown. Link other pages with site paths, such as /api#errors or /api-reference/files#upload-a-file.
2. Add a new page to navigation in docs.json. When you remove or rename a page, add a redirect to redirects.
3. Push a branch, then make its preview with New preview on the bucket's Overview in the Revdoku dashboard, and open it from there or from the "Revdoku preview" status of the commit.
4. Open a pull request. After the merge, the site publishes again.

A page has no H1: the site shows the title of its front matter. Pages can use the Mintlify components Note, Tip, Warning, Card, CardGroup, CodeGroup, Steps, Tabs and Accordion. In an .mdx file, braces outside code are expressions: write pages with literal braces, such as {bucket_id}, as .md files.

For questions, email support@revdoku.com.

Examples

examples/ holds runnable JavaScript, TypeScript and Python examples that call the Revdoku API directly, without an SDK. The examples live only in this repository. Start with examples/README.md.

Run the checks after each change to an example:

cd examples
npm ci
npm run build
npm run check
python3 test/python_examples_test.py
pip install flask requests
python3 test/python_receiver_test.py

Edit the TypeScript files. npm run build writes the matching JavaScript, and npm run check fails when the two differ. Do not commit .env or node_modules.