Contribute to documentation
Learn how to contribute to the Prefect docs.
We use Mintlify to host and build the Prefect documentation.
The main branch of the prefecthq/prefect GitHub repository is used to build the Prefect 3.0 docs at docs-3.prefect.io.
The 2.x docs are hosted at docs-2.prefect.io and built from the 2.x branch of the repository.
Fork the repository
All contributions to Prefect need to start on a fork of the repository. Once you have successfully forked the Prefect repo, create a branch with an informative name:
git checkout -b fix-for-issue-NUM
After committing your changes to this branch, you can then open a pull request from your fork that we will review with you.
Setup your local environment
Make sure you have a recent version of Node.js installed. We recommend using nvm to manage Node.js versions.
- Clone this repository.
- Run
cd docs
to navigate to the docs directory. - Run
nvm use node
to use the correct Node.js version. - Run
npm i -g mintlify
to install Mintlify. - Run
mintlify dev
to start the development server.
Your docs should now be available at http://localhost:3000
.
See the Mintlify documentation for more information on how install Mintlify, build previews, and use Mintlify’s features while writing docs.
.mdx
files, which are Markdown files that can contain JavaScript and React components. Was this page helpful?