@yadsh/dsh-doc-impact

Configuration

Create .dsh/doc-impact.yml in the workspace the agent operates on:

version: 1

defaults:
  mode: remind # remind | require-review | require-resolution | require-update
  scope: turn # turn | session
  changeDetection: auto # auto | git | filesystem

rules:
  - id: auth-docs
    description: Authentication behavior documentation
    code:
      include:
        - packages/auth/**
        - packages/server/src/auth/**
      exclude:
        - "**/*.test.ts"
    docs:
      - docs/authentication.md
    direction: code-to-docs # code-to-docs | docs-to-code | bidirectional
    relation: documents # documents | specification | synchronized | related
    mode: require-resolution

  - id: configuration-contract
    code: [packages/config/**]
    docs: [docs/configuration.md]
    direction: bidirectional
    relation: specification

Personal overrides belong in .dsh/doc-impact.local.yml, which should be ignored by Git:

disabledRules:
  - legacy-docs

The bundle inserts the dsh-doc-impact Cordis row. Override its defaults in the profile patch when needed:

- id: dsh-doc-impact
  config:
    enabled: true
    configFile: .dsh/doc-impact.yml
    defaults:
      mode: remind
    safety:
      maxReminderRounds: 2
      onLimit: allow # allow | warn | error
    changeDetection:
      maxSnapshotFiles: 10000
    debug: false