Keep docs in sync with model changes

DinoAI can automatically flag documentation gaps whenever you modify a dbt model — no more silently outdated YAML files.

How it works

When you add this rule to your .dinorules file, DinoAI will:

1. Detect that a .sql file has been modified

2. Check whether the corresponding YAML doc file needs updating

3. Ask you before making any changes

Setup

Add the following to your .dinorules file:

Documentation Review on Model Changes:
    - Whenever a dbt model (.sql file) is modified, always check if the corresponding YAML documentation file (e.g. _<model_name>.yml) needs to be updated
    - Review whether any of the following have changed and may require doc updates:
      - Column additions, removals, or renames
      - Changes to business logic or transformations
      - Changes to model description or purpose
      - Changes to materialization or config
    - If documentation updates are needed, ask the user: "The model has changed — would you like me to update the documentation (descriptions, column definitions, etc.) to reflect these changes?"
    - Do not silently skip documentation review; always surface it as a step when modifying models

What DinoAI will check

Change type	Example	Doc update likely needed?
Column added or removed	New revenue_usd column	✅ Yes
Column renamed	rev → revenue_usd	✅ Yes
Business logic changed	Filter added to a metric	✅ Yes
Materialization changed	view → table	✅ Yes
Minor formatting fix	Whitespace cleanup	❌ Probably not

Example interaction

You modify orders.sql to add a new column. DinoAI will respond:

"The model has changed — would you like me to update the documentation (descriptions, column definitions, etc.) to reflect these changes?"

Reply yes and DinoAI will update _orders.yml to match. Reply no to skip and move on.

Why this matters

Without this rule, documentation drifts silently — columns get added, descriptions go stale, and the YAML file stops reflecting reality. Rule 15 makes doc review a first-class step in every model edit, not an afterthought.