Works with v0

Docs that follow
your v0 app

v0 pushes each change of your Next.js app to a branch on GitHub. Keep the docs in a docs folder of that repository. Revdoku makes a preview of each branch and publishes the docs when the branch merges.

Start Free Questions? Ask AI in our docs

No card required.

  • Publishes from GitHub on every push
  • Works with Mintlify repositories
  • API console from your OpenAPI file
  • MCP server and llms.txt for AI agents
  • Ask AI and support tickets
  • Analytics for people and AI agents

Connect the v0 repository to Revdoku

v0 pushes generated changes to a working branch, not to the base branch. Publish in v0 opens a pull request and merges it into the base branch.

In v0:

  1. Open the Project menu (...) and select Settings → GitHub. Select Connect.
  2. Select the Git Scope and enter a Repository Name. Select Create Repository.
  3. Add a docs/ folder with Markdown pages and a docs.json navigation file. Use the prompt in the next section.

In Revdoku:

  1. Create a Revdoku account. In the setup steps, select Connect a GitHub repository.
  2. Select Connect GitHub and give the Revdoku GitHub App access to the repository.
  3. Select Existing GitHub repository. Then select the repository and its base branch, usually main.
  4. In Folder, type docs. Click Import and sync.
  5. Click Publish in Revdoku. Each later merge into the base branch publishes the docs again.

v0 creates a private repository and pushes the code of the project to it. For code that is already on GitHub, start a v0 chat with Import from GitHub.

While the docs site is live, each push to a v0 working branch gets a 24-hour preview of the docs. On GitHub, the commit gets a Revdoku status with the preview link. v0 also makes a Vercel preview of the app for each working branch.

Prompt for v0

Paste this prompt into a v0 chat. v0 pushes the pages to a working branch, so you can read the docs preview before you select Publish.

Add docs for this Next.js app in a docs/ folder.
Do not change the app code.
- docs/index.md: what the app does and who uses it.
- One Markdown page for each main page of the app,
  with numbered steps. Each page starts with front
  matter: title and description.
- docs/docs.json in the Mintlify format, with
  navigation groups that list every page once.
- Describe each route handler under app/api in
  docs/openapi.json: method, path, parameters and
  responses. Add "openapi": "openapi.json" to
  docs/docs.json.

With the OpenAPI file, the docs site gets one reference page for each tag and an API console at /api-reference/console/. People can send real requests to your API from there.

Link the docs from the app

Ask v0 to add a Help link to the navigation of the app. The link opens the docs site, where people search the pages and use Ask AI.

Next to it, add a Contact link with the support address of the docs. Each email becomes a ticket in Revdoku. The built-in support agent drafts a reply from your docs, and a person sends it. AI agents read the same docs through the MCP server of the site and llms.txt.

If the app calls the Revdoku API, add REVDOKU_API_KEY in v0

An app needs a key only when it calls the Revdoku API, for example from an admin page. In Revdoku, a bucket holds the files, the site and the support tickets of one docs site. v0 keeps keys in Vercel environment variables.

  1. In Revdoku, open Account → Access and select Create API key….
  2. Set Bucket access to Selected buckets only and select the bucket of your docs. Set Permission to Read only.
  3. In v0, open the Project menu (...) and select Settings → Environment Variables.
  4. Add REVDOKU_API_KEY with the key as its value.
  5. Apply it to Development for the v0 preview and to Production for the live app.

Do not add the NEXT_PUBLIC_ prefix, because Next.js puts variables with that prefix into the JavaScript for the browser. Call Revdoku only from a route handler or a server action.

v0 GitHub guide · v0 environment variables · Docs for AI agents · Support tickets · Revdoku API

Markdown version
↧
Loading PDF…