Skip to content
atlan-review-doc-sync logo

Atlan Review Doc Sync

atlan-review-doc-sync

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.

atlanhq/atlan-sample-apps0installs5stars

SKILL.md

Full skill instructions

Atlan Review Doc Sync

Produce high-signal review findings and keep docs aligned.

Workflow

  1. Review code and tests with bug/​risk/​regression priority.
  2. Report findings first, then brief change summary.
  3. Update app-level docs (README, architecture notes, test notes) to match actual behavior.
  4. Run atlan-fact-verification-gate if behavior-critical claims need source confirmation.
  5. Validate implementation against selected quality tier from ../​_shared/​references/​app-quality-bar.md.
  6. Confirm SDK/​CLI remain untouched.
  7. 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 skills from atlanhq

atlan-fact-verification-gate logo
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.

5 0
View
atlan-sdk-objectstore-io-defaults logo
atlanhq/atlan-sample-apps

atlan-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.

5 0
View
atlan-workflow-args-secrets-state logo
atlanhq/atlan-sample-apps

atlan-workflow-args-secrets-state

Implement workflow argument retrieval, credential_guid usage, and state store updates using Atlan SDK patterns. Use when workflows or activities handle credentials, runtime args, or persisted workflow state.

5 0
View
atlan-e2e-contract-validator logo
atlanhq/atlan-sample-apps

atlan-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 0
View

Popular AI tools

Kaiber logo
Video

Kaiber

Generate, edit, and beat-sync AI video with leading models in one workspace.

Paid
View
Vimcal logo
Productivity

Vimcal

The world's fastest calendar for remote work

Free
View

Transform Your Design with AI Designer by ImgCreator.ai

Freemium
View
Akool AI logo
Content & writing

Akool AI

Revolutionizing Video Production with AI-Powered Creativity

Paid
View

Extend an image past the frame and let AI fill the new aspect ratio.

Freemium
View
StarByFace logo
Security

StarByFace

Discover your celebrity doppelgänger with StarByFace!

Free
View
C

ChainClarity explains 700+ crypto whitepapers in plain English, with layered summaries, comparisons, research tools, alerts, and a $4.99 Pro plan.

Freemium
View
Opus Clip logo
Coding & apps

Opus Clip

Opus.ai: Revolutionize Your Web Experience

Free
View