waveterm/waveterm-docs-old
0
0
Fork 0
mirror of https://github.com/wavetermdev/waveterm-docs-old.git synced 2026-08-05 13:42:53 -07:00
Code Issues Packages Projects Releases Wiki Activity

updated readme for easier readability and added a reference to mintlifys docs

Browse Source
This commit is contained in:
Knox Lively
2024-02-26 13:45:14 -07:00
parent 81190a4762
commit 8e94cb661a
1 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -2
View File
@@ -13,14 +13,24 @@ We welcome contributions to Wave docs!
### Development Environment
Wave documentation is built on Mintlify. To develop, install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command
Wave documentation is built on [Mintlify](https://mintlify.com/). To develop, install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally.
**Step 1:**
Install Mintlify:
```
npm i -g mintlify
```
Run the following command at the root of your waveterm-docs repo (where mint.json is)
**Step 2:**
Navigate to the docs directory (where the mint.json file is located) and execute the following command:
```
mintlify dev
```
A local preview of your documentation will be available at http://localhost:3000.
### Additional Info
For comprehensive details on configuring your development environment, as well as a complete reference guide, please refer to [Mintlify's documentation](https://mintlify.com/docs/development).