This ReadMe provides instructions on how to edit the Whop Developer documentation.
We use Mintlify for our documentation. To run the documentation locally on your machine, you will need to install their CLI.
Use the following command:
npm i -g mintlify
Once you have installed the CLI, you can now start making your changes. After you have cloned the repository, run the following command at the root of the project (where the mint.json file is)
mintlify dev
This will run the documentation on localhost:3000, head there and you will see the documentation!
This documentation uses Markdown (MDX) and Mintlify's custom components. It is not possible to use custom React components, only native Mintlify ones. You can find more details about the ones available to you here
If you are creating new pages, you will also need to add them to the navigation. To do this, head to the mint.json file. This is where all the navigation configuration lives.Find the relevant group, and add in the path of your new page.
To learn more about navigation, head to the Mintlify Documentation
Once you've submitted your contribution, the Whop team will review your changes, provide feedback, and merge the pull request when it's ready. If your change were merged, you will also be added to our Contributors page.