You've already forked waveterm-docs-old
mirror of
https://github.com/wavetermdev/waveterm-docs-old.git
synced 2026-04-22 15:22:42 -07:00
Evan Simkowitz
36 lines
1.4 KiB
Markdown
36 lines
1.4 KiB
Markdown
# WaveLegacy Documentation
|
|
|
|
This repo contains the WaveLegacy Documentation, which is hosted at [legacydocs.waveterm.dev](https://legacydocs.waveterm.dev/).
|
|
|
|
## Contributing
|
|
|
|
We welcome contributions to Wave docs!
|
|
|
|
* For minor changes, you are welcome to [open a pull request](https://github.com/wavetermdev/waveterm-docs-old/pulls).
|
|
* For major changes, please [create an issue](https://github.com/wavetermdev/waveterm-docs-old/issues/new) first.
|
|
* If you are looking for a place to start take a look at [open issues](https://github.com/wavetermdev/waveterm-docs-old/issues).
|
|
* Join the [Discord channel](https://discord.gg/XfvZ334gwU) to collaborate with the community on your contribution.
|
|
|
|
### Development Environment
|
|
|
|
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
|
|
```
|
|
|
|
**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). |