Quick start
This page explains how to read these docs, and how maintainers update them.
For readers
Content falls into two categories:
| Category | Contents | Entry |
|---|---|---|
| Guide | Concepts, onboarding paths, best practices | Guide |
| Product docs | Features, parameters and FAQs per product | Product docs |
The top bar has full-text search and a language switcher for 中文 / English / ไทย.
For maintainers
Everything is a Markdown file in the repository — there is no separate admin backend. Three ways to update:
bash
git clone https://github.com/FridaF-SI/WAND-docs.git
cd moonheart-docs
npm install
npm run docs:dev # live preview at http://localhost:5173bash
git add docs/
git commit -m "docs: update product A features"
git push # EdgeOne Pages builds and deploys automaticallyThe third option is to edit the .md file directly on GitHub — saving it triggers the same automatic deployment.
Adding a page
- Create
your-product.mdunderdocs/en/products/ - Start the file with front-matter:
markdown
---
title: Your product name
description: One sentence, used for search results and SEO.
---
# Your product name- Register it in the
sidebarsection ofdocs/.vitepress/config.mts - Commit and push
On multiple languages
Chinese lives in docs/, English in docs/en/, Thai in docs/th/, and all three mirror the same path structure. The English version of docs/products/product-a.md is docs/en/products/product-a.md. The automated translation workflow depends on this convention.
Next steps
- Read core concepts to understand how docs are organised
- Browse the product docs overview