atlan-review-doc-sync
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-gateif 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
More from atlanhq/atlan-sample-apps
atlan-fact-verification-gate
Verify Atlan app behavior against SDK docs/code and CLI docs/code before behavior-changing decisions; use lightweight checks by default and deep checks when risk is high.
10atlan-sdk-objectstore-io-defaults
Enforce object store and IO defaults from the Atlan SDK for output paths, prefixes, and file writes. Use when implementing or reviewing raw/transformed output handling.
8atlan-cli-run-test-loop
Run Atlan app execution loops using CLI-first commands with automatic CLI availability checks and safe fallbacks.
5atlan-app-scaffold-standard
Scaffold new Atlan apps from CLI templates as the default behavior when users ask for a new app, then align files to sample-app standards.
5atlan-sql-connector-patterns
Select and apply the correct SQL connector implementation pattern (SDK-default minimal or source-specific custom). Use when building or extending SQL metadata/query extraction connectors.
5atlan-e2e-contract-validator
Generate and validate e2e test contracts for Atlan workflows, including API responses, output paths, and schema assertions. Use when adding or updating workflow e2e coverage.
5