Documentation

documentation is compatible with the Mintlify platform out of the box. If you use another documentation platform, get in touch for assistance.

Mintlify integration

Follow the steps below to whitelabel our documentation using Mintlify.

Import project

Go to your Mintlify directory then import the whitelabel project:

git submodule add https://github.com/agentfirstdev/whitelabel

Customize documentation

Switch to the whitelabel subdirectory then customize the documentation by calling the whitelabel script with a subdirectory name and URL path to nest the documentation under, as well as your company name, support email address, API domain, usage dashboard URL, and checkout URL:

cd whitelabel
npm run whitelabel -- \
--path '[subdirectory/pathname here]' \
--company '[company name here]' \
--email [support address here] \
--endpoint [API domain here] \
--dashboard [dashboard URL here] \
--checkout [top-up URL here]

View customization example

We used endpoints, as in https://doc.agentfirst.dev/endpoints/search, Agent First, brain@agentfirst.dev, api.agentfirst.dev, https://agentfirst.dev/dashboard, and https://agentfirst.dev/#pricing:

cd whitelabel
npm run whitelabel -- \
--path endpoints \
--company 'Agent First' \
--email brain@agentfirst.dev \
--endpoint api.agentfirst.dev \
--dashboard https://agentfirst.dev/dashboard \
--checkout https://agentfirst.dev/#pricing

Link pages

Link to whichever tutorial and reference pages you want in your navigation by editing the docs.json file at the Mintlify root.

View navigation example

Here’s how we link from our configuration file:

...
"navigation": {
  "groups": [
    ...
    {
      "group": "API",
      "pages": [
        "endpoints/search",
        "endpoints/browser",
        "endpoints/geotargeting",
        "endpoints/scheduling",
        "endpoints/reporting",
        {
          "group": "Reference",
          "icon": "book",
          "iconType": "light",
          "pages": [
            {
              "group": "Search",
              "pages": [
                "endpoints/reference/search",
                "endpoints/reference/search/results"
              ]
            },
            {
              "group": "Browsing",
              "pages": [
                "endpoints/reference/browser",
                "endpoints/reference/browser/content",
                "endpoints/reference/browser/devices"
              ]
            },
            {
              "group": "Reporting",
              "pages": ["endpoints/reference/usage"]
            },
            ...
          ]
        }
      ]
    },
    ...
  ]
},
...

Preview changes

Switch back to the Mintlify root then preview your changes as usual:

cd ..
mint dev

A local copy of your documentation will be hosted at http://localhost:3000/.

Publish changes

Publish your changes after reviewing them:

git push

If you’ve connected your repository to Mintlify, your documentation will be automatically deployed.

Incorporate updates

To incorporate documentation updates later, resync the whitelabel project from your Mintlify directory then invoke the customization script again:

git submodule update --remote
cd whitelabel
npm run whitelabel -- \
--path '[subdirectory/pathname here]' \
--company '[company name here]' \
--email [support address here] \
--endpoint [API domain here] \
--dashboard [dashboard URL here] \
--checkout [top-up URL here]

Introduction

Core API

Shared options

API management

For service providers

Mintlify integration

​Mintlify integration

Mintlify integration