Guide

This section explains how to use and maintain this book, aiming to reduce collaboration costs and help new contributors ramp up quickly.

What belongs here

  • Getting started & preview: how to install mdBook, run local preview, and build
  • Writing style: heading levels, code blocks, links, images, naming conventions
  • Collaboration conventions: review flow, how to submit docs, how to split chapters

What does not belong here

  • Specific feature designs (put them in en/design/)
  • Final decisions (put them in en/adr/)
  • Meeting notes / process discussions (put them in en/discussions/)

Naming tips

  • File names: lowercase English words with - (e.g. writing-style.md)
  • Titles: keep them short and scannable; include technical terms when helpful