Skip to content

QUA-1024: Restructure After Date Time check docs#1149

Open
RafaelOsiro wants to merge 3 commits into
mainfrom
qua-1024-after-date-time-rule-type
Open

QUA-1024: Restructure After Date Time check docs#1149
RafaelOsiro wants to merge 3 commits into
mainfrom
qua-1024-after-date-time-rule-type

Conversation

@RafaelOsiro

@RafaelOsiro RafaelOsiro commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Overview

Restructure the After Date Time rule type documentation from a single page into the 5-page hub pattern (Introduction, How It Works, Examples, API, FAQ), aligned with the QUA-1024 playbook used for Unique, AI Managed, Data Diff, Expected Values, and Entity Resolution.

Key Changes

  • New hub at docs/data-quality-checks/after-date-time/ with introduction.md, how-it-works.md, examples.md, api.md, and faq.md.
  • Introduction: formal definition, single-field scope with Date/Timestamp accepted types (icons sized with .lg), General + Specific Properties, all anomaly types, and a Next Steps card grid. H1 uses the standard :material-book-open-variant: Introduction fallback.
  • Standard Icons applied across the hub: book-open-variant (Introduction H1), file-cog (How It Works H1 and corresponding card), no H1 icon on Examples (and no icon on the Examples card per the destination-sync rule), api (API H1), help-circle-outline (FAQ H1).
  • How It Works: evaluation flow, NULL handling, cutoff and time zone behavior, filter clause, coverage and tolerance, anomaly templates, Source Records highlighting, Custom Anomaly Description, relationship with Before Date Time / Between / Not Future / Not Null / Freshness, and performance considerations.
  • Examples: three production scenarios (system cutover, daily ingestion window with filter, pre-migration survivors) with check configuration, payload, sample data with anomalous-cell highlights, anomaly messages, mermaid flowchart, and equivalent SQL.
  • API: endpoint matrix, permission breakdown (Active vs Draft for POST/PUT, Author for DELETE, Reporter for GET), payload example, field notes table, and PUT editable/immutable lists (3 immutables: rule, container_id, template_id).
  • FAQ: 13 questions across Behavior, Anomaly Reporting, and Configuration, including the filter suffix on both Record and Shape, Custom Anomaly Description fallback, and immutability on PUT.
  • extra.css: adds the .anomalous-cell class to highlight individual table cells in Examples sample data.
  • mkdocs.yml: nested nav under "After Date Time" plus redirects from checks/after-date-check.md and data-quality-checks/after-date-check.md to the new introduction.
  • Cross-references: overview-of-a-check.md, rule-types-overview.md, and operations/profile/profile.md repointed to the new hub path.
  • Removed: legacy docs/data-quality-checks/after-date-check.md.

Pages to Test

@RafaelOsiro RafaelOsiro added the documentation Improvements or additions to documentation label Jun 20, 2026
@RafaelOsiro RafaelOsiro self-assigned this Jun 20, 2026
@greptile-apps

greptile-apps Bot commented Jun 20, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR restructures the After Date Time check documentation from a single legacy page into a 5-page hub (Introduction, How It Works, Examples, API, FAQ), following the same QUA-1024 playbook applied to other rule types. Cross-references in overview-of-a-check.md, rule-types-overview.md, and profile.md are updated, backward-compatibility redirects are added in mkdocs.yml, and a new .anomalous-cell CSS class is introduced to highlight anomalous table cells in the Examples page.

  • New hub at docs/data-quality-checks/after-date-time/ with five pages covering definition, evaluation semantics, three production scenarios (with payloads, sample data, flowcharts, and SQL), the full API surface, and 13 FAQ entries.
  • Navigation and redirects updated so both legacy paths (checks/after-date-check.md and data-quality-checks/after-date-check.md) redirect to the new introduction without breaking existing links.
  • Minor gap in how-it-works.md: the Custom Anomaly Description section omits the null/missing/empty fallback that api.md and faq.md document correctly.

Confidence Score: 5/5

Documentation-only restructure with no logic changes; all cross-references and redirects are correctly wired.

The change is purely additive documentation work. The new hub pages are internally consistent, the nav and redirect configuration in mkdocs.yml correctly covers both legacy URL paths, and all updated cross-references point to valid new paths. No executable code is modified.

how-it-works.md — the Custom Anomaly Description section is the one spot where the null/missing/empty fallback is not documented, while api.md and faq.md cover it correctly.

Important Files Changed

Filename Overview
docs/data-quality-checks/after-date-time/introduction.md New hub landing page with formal definition, field scope, general/specific properties, anomaly types, and Next Steps card grid — follows the established 5-page pattern cleanly.
docs/data-quality-checks/after-date-time/how-it-works.md Comprehensive semantic reference covering evaluation flow, NULL handling, time zones, filter, coverage, anomaly templates, relationships, and performance; Custom Anomaly Description section omits the null/missing/empty fallback that api.md and faq.md document correctly.
docs/data-quality-checks/after-date-time/examples.md Three well-structured production scenarios (cutover, daily ingestion with filter, pre-migration survivors) with config tables, payloads, annotated sample data, anomaly messages, mermaid flowcharts, and equivalent SQL; all examples are internally consistent.
docs/data-quality-checks/after-date-time/api.md Complete API reference with endpoint matrix, permission breakdown, payload example, field notes table (including the null/missing/empty fallback for anomaly_message_field), and PUT editable/immutable breakdown.
docs/data-quality-checks/after-date-time/faq.md 13 questions across three groups (Behavior, Anomaly Reporting, Configuration); all answers are accurate and consistent with how-it-works.md and api.md.
mkdocs.yml Nested nav added under After Date Time and two redirects added (checks/after-date-check.md and data-quality-checks/after-date-check.md both point to the new introduction page); existing redirect chain is correct.
docs/stylesheets/extra.css Adds .anomalous-cell class for highlighting table cells; border uses CSS variable var(--q-orange) but background hardcodes the same orange as a raw rgba value, which would drift if the variable is ever updated.
docs/data-quality-checks/after-date-check.md Legacy single-page doc deleted; content replaced by the new 5-page hub. mkdocs.yml redirects preserve backward compatibility.
docs/data-quality-checks/overview-of-a-check.md Single-line update to repoint the After Date Time row to the new hub introduction path.
docs/data-quality-checks/rule-types-overview.md Single-line update matching the overview-of-a-check.md change.
docs/operations/profile/profile.md AI Managed checks table After Date Time row updated to point directly to the new introduction URL, bypassing the now-redirected legacy path.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A["Legacy URLs\nchecks/after-date-check.md\ndata-quality-checks/after-date-check.md"] -->|"mkdocs redirect"| B["Introduction\nafter-date-time/introduction.md"]
    B --> C["How It Works\nafter-date-time/how-it-works.md"]
    B --> D["Examples\nafter-date-time/examples.md"]
    B --> E["API\nafter-date-time/api.md"]
    B --> F["FAQ\nafter-date-time/faq.md"]
    G["overview-of-a-check.md"] -->|"updated link"| B
    H["rule-types-overview.md"] -->|"updated link"| B
    I["profile.md"] -->|"updated link"| B
Loading
%%{init: {'theme': 'base', 'themeVariables': {"darkMode": true, "background": "#0d1117", "primaryColor": "#21262d", "primaryTextColor": "#e6edf3", "primaryBorderColor": "#8b949e", "lineColor": "#8b949e", "textColor": "#e6edf3", "edgeLabelBackground": "#161b22", "actorBkg": "#21262d", "actorBorder": "#8b949e", "actorTextColor": "#e6edf3", "actorLineColor": "#8b949e", "signalColor": "#8b949e", "signalTextColor": "#e6edf3", "noteBkgColor": "#373320", "noteBorderColor": "#d4a72c", "noteTextColor": "#f0e6c0", "labelBoxBkgColor": "#21262d", "labelBoxBorderColor": "#8b949e", "labelTextColor": "#e6edf3", "loopTextColor": "#e6edf3", "activationBkgColor": "#30363d", "activationBorderColor": "#8b949e"}}}%%
flowchart TD
    A["Legacy URLs\nchecks/after-date-check.md\ndata-quality-checks/after-date-check.md"] -->|"mkdocs redirect"| B["Introduction\nafter-date-time/introduction.md"]
    B --> C["How It Works\nafter-date-time/how-it-works.md"]
    B --> D["Examples\nafter-date-time/examples.md"]
    B --> E["API\nafter-date-time/api.md"]
    B --> F["FAQ\nafter-date-time/faq.md"]
    G["overview-of-a-check.md"] -->|"updated link"| B
    H["rule-types-overview.md"] -->|"updated link"| B
    I["profile.md"] -->|"updated link"| B
Loading

Reviews (2): Last reviewed commit: "docs(after-date-time): document anomaly_..." | Re-trigger Greptile

Comment thread docs/data-quality-checks/after-date-time/api.md Outdated
@RafaelOsiro

Copy link
Copy Markdown
Contributor Author

@greptileai review

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