This repository contains the source content for the RisingWave user documentation. The content is published to the docs website by Docusaurus 2.
To help us improve the RisingWave user documentation, you may:
If you are not familiar with writing and formatting on GitHub, get started by reading Basic writing and formatting syntax on GitHub.
If you would like to view your changes on the docs locally before submitting a pull request:
If you don't have yarn
in your local machine, run npm i -g yarn
to install it.
Open the risingwave-docs
repo in terminal and run:
yarn
yarn start
The rendered docs will open in your browser automatically.
Check out the published user docs at RisingWave Docs.