mirror of
https://github.com/awatertrevi/infisical.git
synced 2026-10-06 07:26:45 +00:00
Merge pull request #1110 from techemmy/docs/add-REAMDE-for-contributing-to-the-docs
docs: add README file for instructions on how to get the doc started …
This commit is contained in:
@@ -0,0 +1,24 @@
|
|||||||
|
# Contributing to the documentation
|
||||||
|
|
||||||
|
## Getting familiar with Mintlify
|
||||||
|
New to Mintlify. [Start Here](https://mintlify.com/docs/quickstart)
|
||||||
|
|
||||||
|
|
||||||
|
## 👩💻 Development
|
||||||
|
|
||||||
|
Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
|
||||||
|
|
||||||
|
```
|
||||||
|
npm i -g mintlify
|
||||||
|
```
|
||||||
|
|
||||||
|
Run the following command at the root of your documentation (where mint.json is)
|
||||||
|
|
||||||
|
```
|
||||||
|
mintlify dev
|
||||||
|
```
|
||||||
|
|
||||||
|
## Troubleshooting
|
||||||
|
|
||||||
|
- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
|
||||||
|
- Page loads as a 404 - Make sure you are running in a folder with `mint.json`. Check the `/docs` folder
|
||||||
Reference in New Issue
Block a user