Skip to content

docs.instructions.md

Latest commit

 

History

History
11 lines (9 loc) · 462 Bytes

docs.instructions.md

File metadata and controls

11 lines (9 loc) · 462 Bytes
Raw
applyTo **/*.{md,mdx}

Documentation Review Instructions

  • Verify that examples match the actual API, are self-contained, and focus on the relevant behavior.
  • Check that changed headings follow the document hierarchy.
  • Verify that changed internal links and anchors lead to the intended content.
  • Ensure documentation explains public behavior.
  • Use diffs or before and after code snippets in migration guides when they help explain the change.