Skip to content

agentfirstdev/whitelabel

Repository files navigation

Agent First X post

The missing services for agent-first development

Whitelabel documentation

Agent First’s documentation has been optimized for whitelabeling on the Mintlify platform. If you use another documentation platform, contact us to get help.

Mintlify integration

Follow the steps below to host our documentation on Mintlify.

  1. Import submodule

    Go to your Mintlify directory then import this project:

    git submodule add https://github.com/agentfirstdev/whitelabel
  2. 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]

    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
  3. Link pages

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

    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"] },
                "..."
              ]
            }
          ]
        },
        "..."
      ]
    },
    "..."
  4. 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/.

  5. Publish changes

    Publish your changes after reviewing them:

    git push

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

  6. Incorporate updates

    To incorporate documentation updates later, resync this project from your Mintlify directory then invoke the whitelabel 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]

License

Copyright 2025– Agent First Dev, LLC.

This program is free software, excluding the brand features and third-party portions of the program identified in the Exceptions below: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Exceptions

The Agent First logos, trademarks, domain names, and other brand features used in this program cannot be reused without permission and no license is granted thereto.

About

This repository contains resources for whitelabeling Agent First.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors