Dt Review Pr

Review documentation changes from a pull request

Reviews the markdown files changed in a pull request against the Dynatrace corporate style guide. Outputs a structured violation report.

Arguments

The command receives its input via $ARGUMENTS. Accepted formats:

Arguments can be combined: 9089 --repo /workspace/dynatrace-docs.

If no arguments are provided, ask the user for a PR number or branch name.

Procedure

1. Parse arguments

Extract from $ARGUMENTS:

• target: the PR number (all digits) or branch name (anything else that is not a flag).
• repo_path: value after --repo, or the current working directory if absent.
• doc_type: value after --doc-type, or product-docs if absent.

If no target is found, ask the user: "Please provide a PR number or source branch name."

2. Resolve changed files

cd into repo_path. Then:

2a. If target is a PR number

# Look for the merge commit in ALL branches/tags
git log --all --oneline --grep="Pull request #<NUMBER>:" | head -5

• Merge commit found (PR is merged):

  • Extract the commit SHA.
  • Get the diff: git diff <SHA>^..<SHA> --name-only -- '*.md'
  • This gives the list of changed markdown files.

• No merge commit (PR is open/unmerged):

  • Search remote branches for the PR number or related branch:

    git fetch --all --prune 2>/dev/null
    git branch -r | grep -i "<NUMBER>" | head -5
    

  • If a matching remote branch is found, diff it:

    git diff origin/main...origin/<branch> --name-only -- '*.md'
    

  • If no branch is found, tell the user: "Could not find PR # in the local git history or remote branches. Try providing the source branch name instead."

2b. If target is a branch name

# Fetch the branch if not already local
git fetch origin <branch> 2>/dev/null

# Diff against main
git diff origin/main...origin/<branch> --name-only -- '*.md'

If the diff is empty, also try main...<branch> (local branch) and main...remotes/origin/<branch>.

3. Filter to documentation files

From the list of changed files, keep only .md files. Exclude:

• CHANGELOG.md, README.md, CONTRIBUTION.md, RELEASING.md (repo meta files)
• Files under node_modules/, .git/, .docstack/, .ci/, pr-reviewer/

If no documentation files remain after filtering, report: "No documentation markdown files were changed in this PR."

4. Verify files exist on disk

For each changed file, check if it exists in the working tree. Files that were deleted in the PR won't exist — skip those and note them in the report.

For files that exist, resolve to absolute paths.

5. Run dt-style-checker

Invoke the dt-style-checker sub-agent with:

• agent_type: "dt-style-guide:dt-style-checker"
• Pass input block:

files:    [<absolute paths of existing changed files>]
doc_type: <doc_type from arguments>

Collect the violation report.

6. Run Vale (optional)

Check if <repo_path>/.vale.ini exists. If it does:

# Check if vale is installed
which vale 2>/dev/null || echo "NOT_INSTALLED"

If Vale is installed and .vale.ini exists, run it on the changed files:

cd <repo_path>
vale --output=line <file1> <file2> ... 2>&1

Collect Vale findings separately. If Vale is not installed, note: "Vale is not installed — skipping automated linting. Style check is based on dt-style-checker only."

7. Get the diff context

For each file with violations, get the actual diff hunks to show what changed:

# For merged PRs:
git diff <SHA>^..<SHA> -- <file>

# For branches:
git diff origin/main...origin/<branch> -- <file>

This helps the user see violations in context of what was changed.

8. Report

Output a structured report:

## PR Review: #<NUMBER> (or branch: <name>)

### Summary
- Files changed: X documentation files (Y deleted, skipped)
- Style violations: X (MAJOR: N, MINOR: N, NIT: N)
- Vale findings: X (error: N, warning: N, suggestion: N)  — or "N/A (Vale not available)"

### Violations by file

#### `<relative-path>`

| Line | Severity | Rule | Message | Suggestion |
|------|----------|------|---------|------------|
| 42   | MAJOR    | DT.Terminology.WrongProductName | ... | ... |

<diff context showing the changed lines around the violation>

#### `<next-file>`
...

### Vale findings (if available)
<Vale output grouped by file>

### Deleted files (skipped)
- `path/to/deleted.md`

### Recommendations
<Top 3 most impactful things to fix, prioritised by severity>

9. Offer to fix

After the report, ask: "Would you like me to fix the violations I found? I can apply safe, mechanical fixes (terminology, banned words, formatting). Ambiguous cases will be skipped."

If the user says yes, invoke the dt-doc-fixer sub-agent with:

• agent_type: "dt-style-guide:dt-doc-fixer"
• Pass the violation list and the file paths.

Hard rules

• Work in any repo — don't assume dynatrace-docs structure. But optimise for repos with Bitbucket-style merge commit messages (Pull request #<N>: ...).
• Never modify files during the review phase. Fixes happen only via dt-doc-fixer and only when the user explicitly approves.
• Show violations in diff context so the user can see what changed alongside what violated the style guide.
• Respect .gitignore — don't review generated or vendored files.
• If git operations fail, report the error clearly and suggest the user provide a branch name or file paths directly.