# yaml-language-server: $schema=https://raw.githubusercontent.com/jackchuka/mdschema/main/schema.json

structure:
  - heading: "# README"
    children:
      # ===================
      # REQUIRED SECTIONS
      # ===================

      # What this module does - REQUIRED
      - heading: "## Overview"

      # Main capabilities - REQUIRED
      - heading: "## Key Features"
        lists:
          - min: 1
            type: unordered
            min_items: 1

      # Module scope - REQUIRED
      - heading: "## Module Scope"
        children:
          - heading: "### In Scope"
            lists:
              - min: 1
                type: unordered
                min_items: 1
          - heading: "### Out of Scope"
            lists:
              - min: 1
                type: unordered
                min_items: 1
          - heading: "### Scope Decision Rationale"
            description: "Explain why capabilities are in-scope or out-of-scope — domain alignment, separation of concerns, etc."
            paragraphs:
              min: 1

      # Module dependencies - REQUIRED
      - heading: "## Module Dependencies"
        lists:
          - min: 0
            type: unordered
            min_items: 1

# Link validation
links:
  validate_internal: true
  validate_files: true

# Heading rules
heading_rules:
  no_skip_levels: true
  unique: true
  max_depth: 3