Skip to content

Content Style

Use these conventions for all pages under docs/.

  • Write for user outcomes first, implementation detail second.
  • Use short titles, short paragraphs, and direct sentences.
  • Remove repeated context, qualifiers, and navigation prose.
  • Prefer concrete command examples with expected context.
  • Keep terminology consistent: use “documentation site” for arashi-docs.
  • Keep workflow pages task-oriented; move exhaustive contracts to Reference or Commands.
  • Use one # heading per page through frontmatter title.
  • Use ## and ### headings in logical order.
  • Use fenced code blocks with language identifiers.
  • Use absolute docs links like /contributing/navigation-rules/.
  • Update cross-links when adding, moving, or deleting pages.
  • Include a short description in frontmatter.
  • Keep onboarding and contributor workflow guidance in their matching sections.