Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 670 Bytes

File metadata and controls

18 lines (13 loc) · 670 Bytes

Maintainer Documentation

Scope: develop-docs/**. Also follow root instructions.

Conventions

  • Name maintainer documents with UPPERCASE_SNAKE_CASE.md
  • Link new documents from develop-docs/README.md
  • Add significant decisions to DECISIONS.md with date, contributors, context, rationale, and links
  • Link to source and existing docs instead of duplicating content
  • Use GitHub [!NOTE], [!WARNING], and [!CAUTION] callouts

Keep Documentation Current

  • Architecture changes: ARCHITECTURE.md
  • Build configuration or platform changes: BUILD.md
  • Release process changes: RELEASE.md
  • Integration changes: INTEGRATIONS.md