Skip to content

VitePress Documentation Guide

Use this file when adding or updating docs in apps/docs.

Scope

  • Keep AI-operational docs in apps/docs/files/.
  • Keep all content in English.
  • Prefer short, action-oriented sections with concrete file paths and commands.

Writing style for agent docs

  • Start with purpose and when to use the file.
  • Include canonical commands in runnable form.
  • Reference current workspace names and package identifiers exactly.
  • Avoid stale references to removed paths or renamed apps.

Suggested page structure

text
apps/docs/
  index.md
  files/
    AGENT.md
    architecture.md
    conventions.md
    ...

Local docs commands

bash
pnpm --filter docs docs:dev
pnpm --filter docs docs:build
pnpm --filter docs docs:preview