Writing Docs

About 86 wordsLess than 1 minute

How to edit the MaaKEDR docs site (VuePress Theme Plume).

Layout

docs/zh|en/{manual,develop,protocol}/
docs/.vuepress/config/navigation.ts   # navbar + sidebar

Add new pages to both locale sidebars when applicable.

Frontmatter

---
order: 1
icon: ri:tools-fill
---

Containers

Tips

Tip box

Warning

Preview

pnpm docs:dev
pnpm docs:build

Keep user manuals aligned with tasks/*.json. Keep protocol pages aligned with pipelines. Release notes: update interface.json version / title manually (see AGENTS.md).