Docs for your
Lovable app

Lovable syncs a project with GitHub in both directions. Revdoku reads the same repository and publishes one folder of it as a docs site.

In Lovable:

1. Open Project settings → Git → GitHub.
2. If no GitHub connection shows, a workspace owner or admin selects Add connection → Add account. In the GitHub window, they click Install & Authorize.
3. Click Connect next to the GitHub connection. Lovable creates a private repository and starts the sync.
4. Add a docs/ folder with Markdown pages and a docs.json navigation file. Use the prompt in the next section, or edit the files on GitHub.

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 the branch that Lovable syncs.
4. In Folder, type docs. Click Import and sync.
5. Click Publish. The docs go live at https://<name>.revdoku.site or on your own domain.

Each later push to the branch publishes the docs again, also a change that comes from Lovable. While the site is live, a push to another branch gets a 24-hour preview. Lovable syncs one branch at a time, by default the default branch of the repository.

Paste this prompt into the Lovable chat. It asks Lovable to write the pages from the code of the app. The sync then sends them to GitHub.

Write user docs for this app in a docs/ folder.
Revdoku will publish the folder as a docs site.
Do not change the app.
- docs/index.md: what the app does and who uses it.
- One Markdown page for each main screen or task,
  with numbered steps. Start each page with front
  matter: title and description.
- docs/docs.json in the Mintlify format: a "name" and
  a "navigation" with "groups". Each group has a
  "group" name and its "pages", without ".md".
- If the app has Edge Functions that other programs
  call, describe them in docs/openapi.json.
- Describe only what the code does. Put no keys,
  passwords or customer data in the docs.

With an OpenAPI file, the docs site gets one reference page for each tag and an API console, where people send real requests.

Ask Lovable for a Help menu in the app with two links:

• Docs: the address of your docs site. There, people search the pages and use Ask AI.
• Contact support: a mailto: link to the support address of your docs.

An email to the support address opens a ticket in Revdoku. The built-in support agent drafts a reply from your docs, and a person sends it. On the docs site, a reader who still needs help can leave a message, which arrives as a ticket too. The support tickets page shows the details.

The docs need no API key. The app needs one only if it calls the Revdoku API. For example, an admin page can show the state of the docs site and the number of open support tickets. In Revdoku, a bucket holds the files, the site and the support tickets of one docs site.

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 Lovable, open More → Settings → Secrets and click Add secret.
4. Enter the name REVDOKU_API_KEY and paste the key.

Secrets reach only Edge Functions and other server code, never the browser. Lovable refuses names that start with VITE_, because those values go into the browser code. A remix copies only the names of your secrets, so enter the value again in the copy.

Lovable GitHub sync · Lovable secrets · Docs for AI agents · Support tickets · Revdoku API