Skip to content

QUA-1756: Restructure Scan Operation docs and document Auto-Resolve#1136

Draft
RafaelOsiro wants to merge 1 commit into
mainfrom
qua-1756-auto-resolve-anomalies
Draft

QUA-1756: Restructure Scan Operation docs and document Auto-Resolve#1136
RafaelOsiro wants to merge 1 commit into
mainfrom
qua-1756-auto-resolve-anomalies

Conversation

@RafaelOsiro
Copy link
Copy Markdown
Contributor

Overview

Restructures the Scan Operation documentation under operations/scan/ and adds end-to-end coverage of the new Auto Resolve Anomalies behavior.

Key Changes

  • Scan Operation hub (operations/scan/getting-started.md): New entry point with Deep Dive, How-tos, and Reference card sections; replaces the legacy scan.md (redirected via mkdocs.yml).
  • Deep Dive references: Three new conceptual pages — Read Strategies (Incremental vs Full + Auto-Resolve), Scan Settings (every setting explained), Permissions (team-permission matrix with Admin Bypass callout).
  • 5-step wizard how-tos: Step-by-step walkthroughs for Select Tables, Select Check Categories, Read Settings, Scan Settings, and Schedule Options, each with examples and screenshots.
  • Auto-Resolve coverage: Eligibility rules, what gets resolved, history attribution, and how the feature surfaces in the Activity tab and Scan Results modal.
  • Interpret Scan Results: New how-to with five state-specific tabs (Success, Warning, Failure, Aborted, Running) and detailed UI anatomy reference.
  • API & FAQ refresh: New Scan API page with Interactive API reference banner, base URL, and auto_resolve_passed_anomalies documented; FAQ rewritten with topics across read strategy, anomaly handling, scheduling, permissions, and API.
  • Cleanup: Removed 37 obsolete screenshots from the legacy layout; related pages in anomalies/, container/, data-quality-checks/, explore/, and source-datastore/ updated to link into the new structure.

Pages to Test

Legacy redirect spot-check:

@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Jun 6, 2026
@RafaelOsiro RafaelOsiro self-assigned this Jun 6, 2026
@RafaelOsiro RafaelOsiro marked this pull request as draft June 6, 2026 03:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant