.coderabbit.yml

language: "en-US"
reviews:
  collapse_walkthrough: true
  sequence_diagrams: false
  path_filters: ["!design-files/schematics/**"]
  path_instructions:
    - path: "**/*.*"
      instructions: |
        Review all files and ensure that:
          - File and directory names must:
            - Be in lowercase
            - Use dashes (-) instead of spaces
            - Use dashes to separate numbers from words (e.g., page-2-content.md)
            - Avoid special characters except dashes
            - Use lowercase file extensions
    - path: "content/**/*.md"
      instructions: |
        Review all markdown files and ensure that:
          - Pinout diagrams are inserted using the pinout shortcode.
          - All lists items that are sentences have a period at the end.
          - Spelling and grammar is correct.
          - Additional valid words are listed in the workspace settings file in the cSpell.words property.
          - Voltages that aren't whole numbers should be described with periods, e.g. 3.3V instead of 3V3.
          - All leaf pages should be in their own folder as a page bundle.
          - Device and board intro pages should always have an opening descriptive paragraph before a card with an image of the device or board.
          - Do not use {{< callout >}} shortcodes.
          - "Arduino Pro Micro" and "SparkFun Pro Micro" should always be called "Pro Micro" instead.
          - "Arduino Mega 2560 Pro Mini" should always be called "Mega 2560 Pro Mini" instead.
          - References to click or select an item in the UI should have the UI item in bold.
          - Screenshots must use the screenshot shortcode instead of Markdown image and must have a title that ends in a period.
          - Pinout diagrams must use the pinout shortcode instead of Markdown image.
          - Schematics must use the schematic shortcode instead of Markdown image.
          - Board and device images must be placed in card shortcodes instead of Markdown image.
          - Headings are in sentence case.
          - Links to other documentation pages on the site are absolute, not relative.
          - Table headers are in sentence case.
          - Ohms should use the Ω symbol.
          - Page descriptions are in sentence case and must end in a period.
          - Page titles are in sentence case and do not end in a period.
          - uF should use the µ symbol (µF).
          - All files under the boards and devices folders should have an ogimage specified in the front matter.
          - "WINWING" should be "WinCtrl" instead.
          - "file" shouldn't be used to refer to MobiFlight configuration files. Instead, use "profile" or "project".
    - path: "**/*.svg"
      instructions: |
        Review all SVG files and ensure that:
          - They are minified (using svgo or similar tool to remove comments, whitespace, and unnecessary attributes).
          - They do not contain a viewBox attribute (to ensure consistent scaling behavior).