Skip to content

Merge staging into prod — 26.04 release#1265

Merged
nrichers merged 27 commits intoprodfrom
staging
Apr 3, 2026
Merged

Merge staging into prod — 26.04 release#1265
nrichers merged 27 commits intoprodfrom
staging

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented Apr 3, 2026

Pull Request Description

What and why?

This PR releases our 26.04 docs to production.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

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)

nrichers and others added 27 commits March 25, 2026 11:56
…hor fix (#1250)

* F+R User Action v2 & anchors

* Edits

* Proofread

* ugh

* sdfgsdg

* Perma workflow step anchors

* Updating old anchors

* Other anchors identified
* WIP

* save point

* Edit: Configure workflows

* Save point

* Edit: Manage workflows

* proofread
…-ai-documentation-to-

Add agentic AI scorers to supported models and frameworks reference
* Initial draft

* Updates after chatting with Hunter

* Edits, remove extraneous file embed

* Edits after testing

* More edits after testing

* Minor edits

* Address review comment from Hunter
…filter extension to repo (#1255)

* Preview for LUA filter alternative

* Add category-filter Lua extension for release pages

This extension reads listing-filter config from YAML frontmatter and
injects it as a data attribute for the JavaScript filter to consume.

* Add .quartoignore

* Apply suggestion from @nrichers

* Wildcard paths for .Rmd .quartoignore
… ignore `.Rmd` in Quarto renders (#1253)

* Moving old release notes proccess into archive

* Copyright headers

* Broken link

* Quarto ignore

* Moving .quartoignore to root

* oops forgor to update .gitignore

* .quartoignore

* Update .github/workflows/validate-docs-site.yaml

* Update .github/workflows/validate-docs-site.yaml

* Update .quartoignore

Co-authored-by: Nik Richers <nik@validmind.ai>

* Updated notebooks

* Exclusions in _quarto.yml instead

---------

Co-authored-by: Nik Richers <nik@validmind.ai>
* Allow check-in of baseline template schema docs and make CI workflow fail harder if necessary

* Fix README.md

* Exclude notebooks/EXECUTED/* from AWS S3 sync

* Another test notebook

* Move notebook into EXECUTED path

* Also --exclude executed notebooks on staging & prod

* Delete another test notebook

* Update scripts/generate_template_schema_docs.py
@nrichers nrichers added the internal Not to be externalized in the release notes label Apr 3, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

PR Summary

This pull request introduces a series of changes primarily focused on documentation and instructional materials across multiple notebooks, tutorials, release notes, and workflow configuration files. The main changes are:

  1. Python Version Recommendation Update: Many code cells and alert messages have been updated to change the recommended Python version ranges from "Python 3.8 <= x <= 3.11" (or "3.9 <= x <= 3.11") to "Python 3.8 <= x <= 3.14." This ensures that users are directed to use a newer version that is verified with the code.

  2. Nomenclature Standardization: Several instances of the term "User Action v2" have been replaced with "User Action" to simplify and unify the naming conventions across workflow steps and configuration files.

  3. UI and Link Updates: Minor adjustments in release notes and support documents include an update to a broken/deprecated link for accessing the "Breaking changes & deprecations" documentation and adds missing anchor spans for consistent navigation in training and troubleshooting sections.

  4. Minor Formatting and Consistency Updates: Additional changes include the removal of extraneous markdown comments, adjustments in sidebar and contents navigation markers, and minor tweaks in workflow configuration examples.

The changes do not alter the core functionality of the code but help improve clarity, consistency, and up-to-date guidance for developers and users interacting with the ValidMind platform and its documentation.

Test Suggestions

  • Open and run several notebooks (e.g. quickstart_model_documentation.Rmd, quickstart_model_validation.Rmd, and corresponding .ipynb files) to validate that the updated recommended Python version messages display correctly.
  • Verify that navigation anchors and link updates (especially for 'User Action' and 'Breaking changes & deprecations') work as expected in the rendered HTML documentation and on the ValidMind Platform.
  • Confirm that workflow configuration files correctly reference the updated step terminology without breaking any automated process.
  • Test that the upgrade instructions in the _how-to-upgrade.qmd file render correctly and that the troubleshooting page includes the upgraded content.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: 31f6178

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.66 1.00 0.82
/get-started/get-started.html 0.85 0.70 1.00 0.73
/guide/guides.html 0.81 0.70 1.00 0.82
/index.html 0.93 0.68 1.00 0.82
/releases/all-releases.html 0.86 0.68 1.00 0.73
/support/support.html 0.91 0.70 1.00 0.82
/training/training.html 0.85 0.66 0.96 0.73

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Execute training notebooks for PRs

✓ INFO: Live previews are available —

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 3, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@nrichers nrichers merged commit a9215b5 into prod Apr 3, 2026
10 checks passed
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