.coderabbit.yaml

# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json
language: 'en-US'
early_access: false
reviews:
  profile: 'chill'
  request_changes_workflow: false
  high_level_summary: true
  high_level_summary_instructions: |
    Write the high-level summary in a commit-message style:
    - Use the imperative mood and present tense, such as "Update reference links" or "Refine documentation formatting".
    - Do not use past-tense verbs such as "Updated", "Refined", "Added", "Fixed", or "Changed".
    - Keep each bullet concise and action-oriented, with one clear change per bullet.
    - Prefer repository terminology exactly as written, especially `lynx-ui`.
  poem: false
  review_status: true
  collapse_walkthrough: false
  sequence_diagrams: false
  auto_review:
    enabled: true
    drafts: false
  path_instructions:
    - path: '**'
      instructions: |
        # Documentation & Website Review Process

        You are the guardian of the project's documentation and website consistency.

        1. **Check Documentation Navigation and Localization**:
           If this PR adds, removes, renames, or moves documentation pages, verify that route/sidebar/i18n-related files are updated when needed, including `shared-route-config.ts`, `i18n.json`, and the matching English or Chinese document.
           - Flag missing paired-language updates when the change affects user-facing documentation in only one locale without an obvious reason.

        2. **Check Generated and Synced Content**:
           If this PR changes generated or synced documentation outputs under `sharedDocs/`, `docs/public/lynx-compat-data`, or lynx-ui package docs, verify that the corresponding source or sync script change is present when applicable.
           - If the generated output appears stale or source-less, ask for the source update or regeneration command.

        3. **Naming Conventions**:
           Ensure the project name is always referred to as **lynx-ui** (lowercase).
           - If you find "Lynx UI" or "Lynx-UI", provide a replacement suggestion immediately.
chat:
  auto_reply: true