In our project, it's crucial that our documentation stays in sync with our marketing site. This ensures that our users always have the most up-to-date information about Curator.

Local Development

Follow the instructions to install the Mintlify CLI.

Once you have the CLI installed, you can use it to run the documentation server locally by cd-ing into the documentation folder and running mintlify. From the root of your Curator project:

cd documentation
mint dev

Global Settings

Mintlify is organized by the docs.json file. Read more about setting up your docs.json file on Mintlify's website.

Components

Mintlify supports components that can be used to enhance your documentation.

Documentation syncing process

Once a new Curator release has been created, a gitlab pipeline will kick off that replicates all the files from within the documentation folder to the Curator docs repo on GitHub. This will then trigger a Github action to deploy the updated documentation to https://docs.curator.interworks.com.