docs: setup docs for embedchain (#287)

This commit is contained in:
Deshraj Yadav
2023-07-16 16:33:30 -07:00
committed by GitHub
parent 05a4eef6ae
commit c595003481
21 changed files with 914 additions and 619 deletions

25
docs/README.md Normal file
View File

@@ -0,0 +1,25 @@
# Contributing to embedchain docs
### 👩‍💻 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
```
### 😎 Publishing Changes
Changes will be deployed to production automatically after your PR is merged to the main branch.
#### 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`