This is the organzation-level document.
We use VitePress as the document generator.
You can clone the repo and edit it on your filesystem using Markdown.
- clone this repo using git
- install nodejs(>18) runtime
- install nodejs package manager, we use pnpm
- install dependencies using your package manager
- editing document with
pnpm vitepress dev docs
for previewing - commit changes to a new branch (better follow our organization development guide)
- create a PR (better create a draft PR before you start writing)
- set labels
- link to issues in comment or development(will close them)
- write description for your PR
- write comment for the changes you did