| name | atlan-review-doc-sync |
| description | Run findings-first review for Atlan app changes and synchronize app documentation with implemented behavior. Use when completing a change set, preparing handoff, or auditing regressions. |
Atlan Review Doc Sync
Produce high-signal review findings and keep docs aligned.
Workflow
- Review code and tests with bug/risk/regression priority.
- Report findings first, then brief change summary.
- Update app-level docs (README, architecture notes, test notes) to match actual behavior.
- Run
atlan-fact-verification-gate if behavior-critical claims need source confirmation.
- Validate implementation against selected quality tier from
../_shared/references/app-quality-bar.md.
- Confirm SDK/CLI remain untouched.
- If CLI mismatch surfaced during review, append proposal entry.
Rules
- Prioritize correctness, regression risk, and missing tests.
- Keep review findings concrete with file references.
- Do not modify SDK or CLI docs/code.
References
- Review checklist:
references/review-checklist.md
- Quality bar:
../_shared/references/app-quality-bar.md
- CLI proposals:
../_shared/references/cli-change-proposals.md
