Skip to content

Commit

Permalink
Update contributing - add instructions on how to run Mintlify
Browse files Browse the repository at this point in the history
  • Loading branch information
bonk1t committed Feb 13, 2025
1 parent 03c8ce3 commit 9b2c40b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs_new/contributing/contributing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,23 @@ pip install -r requirements-dev.txt

</Step>

<Step title="Install Documentation Tools" icon="book" iconType="solid">
To work on the documentation, you'll need Mintlify CLI:

```bash
npm i -g mintlify
```

To preview documentation changes locally:

```bash
cd docs_new
mintlify dev
```

The documentation will be available at http://localhost:3000
</Step>

<Step title="Install Pre-Commit Hooks" icon="check" iconType="solid">
Install pre-commit hooks for code quality checks.

Expand Down

0 comments on commit 9b2c40b

Please sign in to comment.