This section gets you started on how to contribute to the MindsDB documentation.
MindsDB’s documentation is run using Mintlify. If you want to contribute to our docs, please follow the steps below to set up the environment locally.
Prerequisite You should have installed Git (version 2.30.1 or higher) and Node.js (version 18.10.0 or higher).
Step 1. Clone the MindsDB Git repository:
Step 2. Install Mintlify on your OS:
Step 3. Go to the docs
folder inside the cloned MindsDB Git repository and start Mintlify there:
The documentation website is now available at http://localhost:3000
.
Getting an Error?
If you use the Windows operating system, you may get an error saying no such file or directory: C:/Users/Username/.mintlify/mint/client
. Here are the steps to troubleshoot it:
C:/Users/Username/.mintlify/
directory.mint
folder.git clone https://github.com/mintlify/mint.git
.Here is the structure of the MindsDB docs repository:
Follow our docs rules and have fun.
Thank you for contributing to the MindsDB docs!