Skip to content

notebooks: Updated evidence & artifact linking on validation reports#518

Merged
validbeck merged 3 commits into
mainfrom
beck/sc-15648/documentation-modular-document-checker
May 22, 2026
Merged

notebooks: Updated evidence & artifact linking on validation reports#518
validbeck merged 3 commits into
mainfrom
beck/sc-15648/documentation-modular-document-checker

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 22, 2026

Pull Request Description

What and why?

sc-15648

Companion to validmind/documentation#1343, updates the Validator Fundamentals series to reflect the new UX for evidence and artifacts.

How to test

Review the sections in these notebooks:

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

Pulled into documentation in validmind/documentation#1343.

Release notes

Covered by:

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@validbeck validbeck self-assigned this May 22, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label May 22, 2026
@validbeck validbeck requested a review from jamadriz May 22, 2026 02:16
Copy link
Copy Markdown

@jamadriz jamadriz left a comment

Choose a reason for hiding this comment

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

  1. Series inconsistency (notebook 4 not updated)
    Notebooks 2 and 3 use the new UX wording, but 4-finalize_validation_reporting.ipynb still references the old UI:

Link Evidence to Report
Link Finding to Report / + Create New Finding
If the product rename is series-wide, notebook 4’s “next steps” section will contradict notebooks 2–3 after this merges.

  1. Small copy nit in notebook 3
    Step 10: “Confirm that validation issue you inserted” → should be “Confirm that the validation issue…”

@validbeck
Copy link
Copy Markdown
Collaborator Author

Series inconsistency (notebook 4 not updated)

Good catch, I fixed it in this patch and I'll pull it into docs in validmind/documentation#1339 as the notebooks need to be refreshed anyway.

Screenshot 2026-05-22 at 1 23 16 PM

@validbeck validbeck requested a review from jamadriz May 22, 2026 20:24
@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This pull request introduces changes exclusively in the Jupyter notebook files located in the tutorials/validation folder. The primary goal of the update is to standardize the notebook JSON structure by explicitly setting the "execution_count" key to null and ensuring that each code cell contains an empty "outputs" array when necessary. In addition, some markdown cells have been revised to update instructions and streamline enumerated steps for linking evidence and artifacts in the validation report. These modifications help maintain consistency across notebook cells and improve the readability of the instructional content without affecting functional test logic.

Test Suggestions

  • Open the updated notebooks in a Jupyter environment and verify that code cells do not produce unwanted output artifacts (i.e., they are properly cleared with null execution counts and empty outputs).
  • Run the notebooks end-to-end to ensure that all tests execute correctly and that the instructions render as expected in the final validation report.
  • Manually review the markdown rendering to ensure that the reordered or renumbered steps in the instructional sections maintain clarity and proper sequence.

@validbeck validbeck merged commit 875a53d into main May 22, 2026
6 checks passed
@validbeck validbeck deleted the beck/sc-15648/documentation-modular-document-checker branch May 22, 2026 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants