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
Sylvia Crowe
636e6d350c
This adds a description of how waveterm can cache a password and what options are tied to this (timeout length, clear on sleep, disable caching).
Wave Terminal Documentation
This repo contains the Wave Terminal Documentation, which is hosted at docs.waveterm.dev.
Contributing
We welcome contributions to Wave docs!
- For minor changes, you are welcome to open a pull request.
- For major changes, please create an issue first.
- If you are looking for a place to start take a look at open issues.
- Join the Discord channel to collaborate with the community on your contribution.
Development Environment
Wave documentation is built on Mintlify. To develop, install the Mintlify CLI 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.