BunshipBunship

Docs Authoring

Interaction conventions and writing guidance for docs pages.

Page interactions

Docs pages include:

  • Copy Markdown
  • Open
  • right-side TOC active state

Writing guidance

  1. Start with outcomes, then explain details.
  2. Prefer product behavior over repository internals.
  3. Use step-based setup instructions for configuration pages.
  4. End each page with clear next-step links.

Mermaid usage

Mermaid diagrams are supported for flow explanations.

Rendering diagram...