Installation steps
Prepare a useful documentation source
Start with current API reference pages, authentication, billing, and troubleshooting. Include canonical public URLs and remove outdated versions or duplicated pages that could conflict.
Choose one canonical page for each task, such as creating an API key or verifying a webhook signature. Put version labels in titles and navigation, and remove redirects that send the crawler to an obsolete release after a new version ships.
Choose your docs platform
For Docusaurus, add `scripts: [{src: 'https://mivochat.app/widget.js', async: true, 'data-site': 'YOUR_SITE_KEY'}]` to `docusaurus.config.js`. For Mintlify, add a custom JavaScript file in the docs repository using its supported custom script setup. For GitBook hosted docs, arbitrary scripts are not generally available; check current integrations and custom-domain options, or put the widget on your marketing site and link to it from the docs.
A platform that accepts JavaScript still needs a public, crawlable documentation URL; a local preview or password-protected staging build cannot serve as a visitor source. If the docs live on a subdomain such as `docs.example.com`, add that exact origin in MivoChat Install settings → Allowed websites and verify that the published host is reachable without a login cookie.
Test what customers ask
Try an API key question, “How do I rotate my webhook secret?”, and a question the docs do not answer. Confirm the answer points to the right page and the unknown case reaches a person.
After publishing, test the same question against the exact docs URL customers use and inspect the source link in the answer. For an unanswerable prompt such as a request for an unpublished roadmap date, check that the assistant admits the gap and the connected team receives the handoff rather than a guessed release commitment.
Before you change the setup
public canonical documentation URLs, current product behavior, and a handoff destination watched by a teammate
the platform-specific integration point; use Docusaurus config, Mintlify custom JavaScript, or a supported GitBook route
a widget makes docs easier to query but does not repair stale content or make private, authenticated pages crawlable
Test the support boundary
- How do I authenticate the first API request?
- How do I rotate a webhook secret safely?
- What happens if I ask about an unreleased feature?
Frequently asked questions
Answers cite old documentation
Remove or update obsolete public URLs and crawl the canonical version rather than leaving competing release pages equally visible.
A docs theme blocks the embed
Use the supported custom-script mechanism for that platform; markdown, CSS fields, and generated HTML are not equivalent injection points.
The assistant cannot retrieve a private guide
Publish a safe public explanation or keep the authenticated material with a human; the widget only uses sources it can access.
The docs widget works but site chat does not
Check the docs hostname in Install settings → Allowed websites separately from the marketing hostname.