Skip to content

Replace defunct test description links with test sandbox in notebooks#510

Merged
nrichers merged 3 commits into
mainfrom
nrichers/sc-15539/integrate-beta-test-sandbox-into-quarto-and
May 22, 2026
Merged

Replace defunct test description links with test sandbox in notebooks#510
nrichers merged 3 commits into
mainfrom
nrichers/sc-15539/integrate-beta-test-sandbox-into-quarto-and

Conversation

@nrichers

Copy link
Copy Markdown
Contributor

Pull Request Description

What and why?

Several notebooks still linked to retired test description pages. Those references are updated to use the beta test sandbox instead, so readers land on the current way to explore and run tests. The behavior for running code in the notebooks is unchanged apart from navigation and documentation links.

How to test

  • Open any of the modified notebooks under notebooks/ and confirm links that previously pointed at defunct test descriptions now point at the test sandbox (or the intended replacement target).
  • Optional: run cells that only print or follow links to confirm URLs resolve in your environment.

What needs special review?

Confirmation that each replacement link matches the surrounding context (comparison tests, raw data, quickstart, tutorials, and use-case notebooks).

Dependencies, breaking changes, and deployment notes

  • None.
  • No deployment steps required.

Release notes

documentation — Notebook learning paths now point readers to the interactive ValidMind test sandbox instead of removed test catalog description links.

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)

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

Copy link
Copy Markdown
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers requested a review from cachafla May 20, 2026 18:32
@nrichers nrichers added the internal Not to be externalized in the release notes label May 22, 2026
@validbeck validbeck self-requested a review May 22, 2026 22:01

@validbeck validbeck left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Looks good, but I moved some notebooks for PRT around so some gnarly merge conflicts need to be resolved.

nrichers added 2 commits May 22, 2026 16:07
@nrichers nrichers merged commit b34fad0 into main May 22, 2026
4 of 5 checks passed
@nrichers nrichers deleted the nrichers/sc-15539/integrate-beta-test-sandbox-into-quarto-and branch May 22, 2026 23:20
@github-actions

Copy link
Copy Markdown
Contributor

PR Summary

This PR refines the documentation across multiple Jupyter notebooks by replacing embedded markdown links with plain text names for tests. The changes remove URL wrappers from test names (e.g., converting "ClassifierPerformance" to "ClassifierPerformance") and ensure that appropriate newline characters are added at the end of text snippets. These modifications improve readability and consistency in the instructional content without affecting any underlying functional code. The updates span instructions for running classifier performance tests, ROC curve tests, class imbalance tests, Pearson correlation tests, and similar validations, thereby streamlining the presentation of the documentation and ensuring users have a clearer guide.

Test Suggestions

  • Render the updated notebooks in Jupyter to verify that newline formatting and text rendering meet expectations.
  • Manually verify that all test instructions display the intended plain text for test names without broken links.
  • Run the notebooks to ensure that no functionality is inadvertently affected by documentation changes.

@nrichers nrichers restored the nrichers/sc-15539/integrate-beta-test-sandbox-into-quarto-and branch May 25, 2026 23:28
@nrichers nrichers deleted the nrichers/sc-15539/integrate-beta-test-sandbox-into-quarto-and branch May 25, 2026 23: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.

3 participants