Skip to main content
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.
1

Import project

Go to your Mintlify directory then import the whitelabel project by choosing a subdirectory name and URL path to nest the documentation under:
git subtree add \
--prefix='[subdirectory/pathname here]' \
--squash \
https://github.com/agentfirstdev/whitelabel \
main
We chose endpoints, as in https://doc.agentfirst.dev/endpoints/search:
git subtree add \
--prefix=endpoints \
--squash \
https://github.com/agentfirstdev/whitelabel \
main
2

Download dependencies

Switch to your new subdirectory then download the Node.js dependencies:
cd '[subdirectory/pathname here]'
npm i
3

Brand documentation

Brand the documentation by calling the whitelabel script with your company name and API domain of choice:
npm run whitelabel -- \
--company='[company name here]'\
--endpoint=[API domain here]
Here’s how we branded our documentation:
npm run whitelabel -- \
--company='Agent First' \
--endpoint=api.agentfirst.dev
4

Link pages

Link to whichever tutorial and reference pages you want in your navigation by editing the docs.json file at the Mintlify root.
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"]
            },
            ...
          ]
        }
      ]
    },
    ...
  ]
},
...
5

Preview changes

Switch 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/.
6

Publish changes

Publish your changes after reviewing them:
git push
If you’ve connected your repository to Mintlify, your documentation will be automatically deployed.
7

Incorporate updates

To incorporate documentation updates later, sync the whitelabel project again:
git subtree pull \
--prefix='[subdirectory/pathname here]' \
--squash \
https://github.com/agentfirstdev/whitelabel \
main
Then, repeat the directions from step 2.