Skip to content

Conversation

@iammuze
Copy link
Collaborator

@iammuze iammuze commented Dec 23, 2025

Overview

This PR includes updated screenshots and content as per the latest release.

Key Changes

  • Updated: Screenshots
  • Updated: Content

@iammuze iammuze self-assigned this Dec 23, 2025
@iammuze iammuze added the documentation Improvements or additions to documentation label Dec 23, 2025
@iammuze iammuze marked this pull request as draft December 23, 2025 12:38
@iammuze iammuze marked this pull request as ready for review December 24, 2025 13:42
Copy link
Contributor

@RafaelOsiro RafaelOsiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

About spelling mistakes, text errors, and formatting, I found these problems.

Now, about the content to review, @shindiogawa will be able to say more.


> There is no value set for any of `O_COMMENT` and `O_ORDERSTATUS`
![deactivate-user](../assets/checks/any-not-null/anomaly-detail.png)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Incorrect Image Alt Text.

![deactivate-user](../assets/checks/any-not-null/anomaly-detail.png)

The alt text says deactivate-user which is clearly copy-pasted from another document. It should describe the actual image, like anomaly-detail or any-not-null-anomaly-detail .

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


**Anomaly Explanation**

In the sample data above, the entry with `O_ORDERKEY` **1** does not satisfy the rule because both `O_COMMENT` and `O_ORDERSTATUS` does not hold a value.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Grammar Error.

...both O_COMMENTandO_ORDERSTATUS` does not hold a value.

Should be do not hold (plural subject requires plural verb):`

...both O_COMMENTandO_ORDERSTATUS do not hold a value.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### Key Takeaway

Any Not Null acts as a safety net that prevents context-less records from silently entering the system, replacing slow and unreliable manual validation with automated enforcement.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hyphenation Issue.

...prevents context-less records...

"Context-less" is awkward. Consider using "contextless" or rephrasing to "records without context".

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Any Not Null acts as a safety net that prevents context-less records from silently entering the system, replacing slow and unreliable manual validation with automated enforcement.

### Field Scope
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Inconsistent Heading Hierarchy.

The section ### Field Scope appears after the "Key Takeaway" section within the example narrative. This breaks the logical flow. The Field Scope, General Properties, Anomaly Types, and Example sections should be at ## level (h2) to match the rest of the document structure, or there should be a clear visual/logical separation.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


Use the **Any Not Null** check when you want to ensure that records are not completely blank across a group of related fields.

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(78.2692% + 41px); height: 0px; width: 100%;"><iframe src="https://demo.arcade.software/YRIqJifrb6cYQeXp6mUK?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Untitled (Wed Dec 24 2025)" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arcade Embed Titles (Lines 21 and 138): Both iframes have titles like Untitled (Wed Dec 24 2025). Consider adding descriptive titles for better accessibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.


### The Solution: Any Not Null

<!--ARCADE EMBED START--><div style="position: relative; padding-bottom: calc(49.1909% + 41px); height: 0px; width: 100%;"><iframe src="https://demo.arcade.software/ikJs6JRwTz8xr8KsDfJ1?embed&embed_mobile=tab&embed_desktop=inline&show_copy_link=true" title="Untitled (Wed Dec 24 2025)" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; color-scheme: light;" ></iframe></div><!--ARCADE EMBED END-->
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arcade Embed Titles (Lines 21 and 138): Both iframes have titles like Untitled (Wed Dec 24 2025). Consider adding descriptive titles for better accessibility.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iammuze iammuze requested a review from RafaelOsiro December 29, 2025 10:37
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.

3 participants