Dt Review Docs

Review documentation files against the Dynatrace style guide

Reviews one or more markdown files against the Dynatrace corporate style guide. Reports violations and optionally applies fixes.

Arguments

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

Paths can be relative (resolved from cwd) or absolute. Multiple paths can be provided: docs/setup/ docs/config/auth.md.

If no arguments are provided, ask the user: "Please provide a file or directory path to review."

Procedure

1. Parse arguments

Extract from $ARGUMENTS:

• paths: one or more file/directory paths (everything that is not a flag).
• fix_mode: true if --fix is present.
• doc_type: value after --doc-type, or product-docs if absent.
• min_severity: value after --severity, or NIT if absent (show all).

If no paths are found, ask the user for a path.

2. Resolve files

For each path in paths:

• If it's a file and ends with .md: add it directly.
• If it's a directory: recursively find all .md files using glob: <path>/**/*.md Exclude paths containing: node_modules/, .git/, .docstack/, .ci/, pr-reviewer/.
• If it doesn't exist: report a warning and continue with other paths.

Resolve all paths to absolute. Deduplicate.

If no files are found after resolution, report: "No markdown files found at the specified path(s)."

3. Report scope

Before running the check, summarise: "Reviewing N markdown file(s) in M director(y/ies) against the Dynatrace style guide..."

If N > 50, warn: "Large review — this may take a while. Consider reviewing a smaller subset."

4. 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>]
doc_type: <doc_type>

If there are more than 20 files, batch them in groups of 20 to avoid overloading the agent context. Combine all results.

Collect the violation report.

5. Run Vale (optional)

Check if .vale.ini exists at or above the file paths. If it does and vale is installed:

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

Collect Vale findings. Merge with dt-style-checker results, deduplicating where both flag the same line for the same issue.

If Vale is not installed or no .vale.ini exists, note it and move on.

6. Filter by severity

If min_severity is set above NIT, filter out violations below that level.

Severity order: BLOCKER > MAJOR > MINOR > NIT.

7. Report

Output a structured report:

## Documentation Review

### Summary
- Files reviewed: N
- Style violations: X (MAJOR: N, MINOR: N, NIT: N)
- Vale findings: X (error: N, warning: N, suggestion: N) — or "N/A"

### Violations by file

#### `<relative-path>`

| Line | Severity | Rule | Message | Suggestion |
|------|----------|------|---------|------------|
| 12   | MAJOR    | DT.WordList.BannedWord | "blacklist" is banned | Use "blocklist" or "denylist" |
| 45   | MINOR    | DT.VoiceTone.PassiveVoice | Passive voice detected | Rewrite in active voice |

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

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

### Top recommendations
1. <Most impactful fix>
2. <Second priority>
3. <Third priority>

8. Fix mode

If fix_mode is true:

1. Show the report first (step 7).
2. Summarise what will be fixed: "Fixable violations: N out of M total. The following categories can be auto-fixed: terminology swaps, banned-word replacements, formatting corrections. Ambiguous violations (voice/tone, structural) will be skipped."
3. Invoke the dt-doc-fixer sub-agent with:
   • agent_type: "dt-style-guide:dt-doc-fixer"
   • Pass the violation list (filtered to fixable categories) and the file paths.
4. After fixing, re-run dt-style-checker on the modified files to verify.
5. Report the final state: "Fixed: N violations. Remaining: M violations (require manual review)."

If fix_mode is false, offer at the end: "Run dt-review-docs <same-paths> --fix to auto-fix the safe violations."

Hard rules

• In review-only mode (no --fix), NEVER modify files. Report only.
• In fix mode, only apply unambiguous fixes. When in doubt, skip and report.
• Batch large reviews to avoid context overflow — max 20 files per checker invocation.
• Relative paths in output — show paths relative to cwd for readability.
• Respect existing formatting — don't reformat entire files when fixing individual violations.
• Deduplicate — if Vale and dt-style-checker flag the same issue on the same line, report it once (prefer the dt-style-checker finding for consistency).