Connect Mintlify
Connect your published Mintlify docs by pasting their address, see which pages Gurusup reads, and fix an address Gurusup cannot read.
Admins only. You need no key and no Mintlify account. Gurusup only reads your public docs, and compares what you publish with what your team says in Slack, meetings and the CRM.
At a glance
| Topic | Details |
|---|---|
| Who can connect | Admins |
| What you need | The public address of your published docs |
| What Gurusup reads | Each page listed in your docs index that changes after you connect, up to 2,000 |
| How changes arrive | Gurusup checks your docs every 6 hours |
| Past content | Gurusup does not read the pages that already exist when you connect: a page comes in when it changes. No Import history. |
| Knowledge access | Default access, Restricted or Private. See Who can read it. |
Before you start
- You are an admin in Gurusup.
- Your docs are published and public. Gurusup does not read docs behind a login.
- Gurusup reads the
llms.txtindex at your docs address and the Markdown version of each page it lists.
Connect Mintlify
Open the Mintlify connector
In the sidebar, open Sources, then Catalog, find Mintlify (use Search sources if you need to) and click Connect on its row. Its page opens. Next to Organization accounts, click Connect for the organization. The dialog Connect Mintlify for the organization opens.
Choose who can read it
In the dialog, under Who can read it, keep Default access, or choose Restricted or Private from Access mode and pick the people who can read it. See Who can read it.
Paste the address
In Docs address, paste the address of your published docs, for example docs.yourcompany.com. You can leave out https://, and an http:// address is read over https. The hints under it read "Use the address of your published documentation. No key is needed." and "The address of your published docs." Gurusup says "Reading your docs sections…".
Check the sections
Gurusup lists your docs sections with how many pages each has, and "Checked every 6 hours". Connect stays off until Gurusup finds at least one page.
Connect
Click Connect. A message says Mintlify is connected, and Gurusup starts checking your pages. It learns each page that changes from then on.
If the address includes a path, for example yourcompany.com/docs, Gurusup only reads pages under that path.
Add another docs site
Each docs address is its own connection and its own source. Open the Mintlify page from Sources or Catalog and click Connect for the organization again. Choose the access, paste the address, wait for the sections and click Connect. Organization accounts then lists every site. Pasting an address you already connected updates that connection instead of adding a second one.
What Gurusup reads
Each page in your docs index becomes one document.
| Part | What Gurusup reads |
|---|---|
| Page | Title, link, section, description and content |
| Code examples | Kept as they are |
| References | Issue keys such as ABC-123 and links to Linear, Jira or GitHub, so Gurusup can join the page with what it learned about those items from other sources |
What Gurusup does not read
| Left out | Why |
|---|---|
| Comments in the page source | Readers of the site do not see them either |
| Pages behind a login | Gurusup reads public docs only |
| Index links to other sites | Only your docs are read |
| Other languages | If your index lists several, Gurusup reads only the first |
| Pages beyond the first 2,000 | The page limit per site |
How changes arrive
- Every 6 hours Gurusup checks your docs again and reads changed pages. When your sitemap shows no new dates, Gurusup skips unchanged pages, and once a day it checks every page anyway and learns the ones whose content changed.
- Removed pages are retired after a complete check no longer finds them.
- More than 2,000 pages. Gurusup reads the first 2,000 and retires no page until your docs are under that. Gurusup reads the first 2,000 and won't remove any page until the site is under that. The app does not show a message for this on the Mintlify page.
- A failed check sets the badge to Check delayed. Gurusup tries again about an hour later.
The connection's row shows "Synced" with the time of the last check. What your docs bring in uses your usage. See Usage and limits.
Who can read it
Each docs address is its own source, with its own access.
| Knowledge access | Who reads it in Brain |
|---|---|
| Default access | Everyone, according to what they are already allowed to see: admins every category, members and agent accounts the categories an admin granted them. |
| Restricted | Only the people you pick. Administrators are not included unless you pick them. |
| Private | Only you. Administrators are not included. |
To change it later, open the Mintlify page and change Access mode under Knowledge access; it saves as soon as you change it and covers only what arrives after that. See Restrict a source to specific people.
Check that it worked
- On Sources, open the Mintlify page. Under Organization accounts, the badge reads Connected.
- Open Ingest and pick the source in the source filter. Your pages appear and move to Learned. See Follow ingestion.
- Change a page and publish it. It comes in again within about 6 hours.
Reconnect
On Sources, open the Mintlify page and click Reconnect on the site's row. The dialog holds your docs address. Click Reconnect to make Gurusup check your docs right away.
A connection stays tied to one docs site. To read another site, click Connect for the organization again. To move to a new address, add the new one and disconnect the old one.
Disconnect
On Sources, open the Mintlify page and click the name of the docs site you want to drop. Then open the three dots on its row ("More actions for" its name) and choose Disconnect, or use Disconnect under Danger zone. A dialog titled "Disconnect [name]?" says "Gurusup stops reading from Mintlify. What it already learned stays." Click Disconnect again to confirm, or Cancel. Gurusup stops checking only that site, nothing changes on it, and what Gurusup already learned stays; see Remove, disconnect and what stays.
If it does not work
These messages show under the address while Gurusup reads it, or after "Could not connect Mintlify." when you click Connect or Reconnect.
| Message | What to do |
|---|---|
| "Paste the address of your published docs, like docs.yourcompany.com." | The address is not valid. Paste only the address of your docs. |
| "Gurusup can't reach this address. Paste the public address of your published docs." | Check that the address opens in a browser without signing in. |
| "Gurusup couldn't find a docs index at this address. Paste the address of your published docs, like docs.yourcompany.com." | Gurusup found no llms.txt index. Check you pasted the address of the docs, not of your main website. |
| "These docs are behind a login. Gurusup only reads public docs for now." | Gurusup reads public docs only. |
| "Gurusup couldn't read your docs at the last check. Your saved content is safe. Gurusup will try again." | After connecting: Gurusup tries again by itself. While connecting: your docs index is larger or more nested than Gurusup reads. Contact support. |
| "This address belongs to a different docs site. Use this connection's docs address, or add a new connection." | Click Connect for the organization again for another site. |
| "We couldn't read your docs because of a problem on our side. Your saved content is safe. Contact support for help." | Contact support. |
| "Ingestion is paused for this organization. Ask your organization admin to resume ingestion before adding content." or "Demo Mode prevents changing external sources. Ask your organization admin to turn off Demo Mode to continue." | Connecting, reconnecting and changing what a source brings in are off, and gurusup stops checking your docs. Disconnect still works while ingestion is paused, but not in Demo Mode. See Connectors overview. |
If pages stop updating:
| Check | What to do |
|---|---|
| The badge reads Check delayed | Gurusup tries again by itself. If it stays, check that your docs open without signing in, then click Reconnect. |
| The page is not in your docs index | Pages not listed there are not read. |
| Less than 6 hours have passed | Changes come in at the next check. Click Reconnect to check now. |
| The item is Paused on Ingest | See Connector troubleshooting. |