Skip to content

docs fixes: Remove old breaking changes/deprecrations from releases & ignore .Rmd in Quarto renders#1253

Merged
validbeck merged 13 commits intomainfrom
beck/sc-15412/release-notes-filter-listing-pages-by-category
Apr 1, 2026
Merged

docs fixes: Remove old breaking changes/deprecrations from releases & ignore .Rmd in Quarto renders#1253
validbeck merged 13 commits intomainfrom
beck/sc-15412/release-notes-filter-listing-pages-by-category

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Mar 27, 2026

Pull Request Description

What and why?

This PR:

  • Moves the old releases breaking changes and older versions of the release scripts into internal archive & fixed any broken links to the old breaking changes and deprecations page
  • Adds a .quartoignore so that local renders of the site don't break thanks to the new .Rmd quickstarts

How to test

  1. Pull down the PR: gh pr checkout 1253
  2. cd site
  3. quarto render --profile development — You should see no broken links or errors (refer to below).

What needs special review?

Added a .quartoignore in site (the root of our "project", not the root of the repo) to prevent the issues with the .Rmd from rendering as it was breaking local renders:

processing file: quickstart_model_validation.Rmd
1/41                   
2/41 [setup]           
3/41                   
4/41 [unnamed-chunk-1] 
Error in `vm()`:
! argument "python_version" is missing, with no default
Backtrace:

 1. └─validmind::vm(...)
 4.   └─reticulate::use_python(python_version)
 5.     └─utils::file_test("-f", python)
 6.       └─base::file.info(x, extra_cols = FALSE)

Quitting from quickstart_model_validation.Rmd:53-61 [unnamed-chunk-1]
Execution halted

It seemed to think I still needed to add the python-version to the init cell manually, or update the ValidMind R package to accommodate a default version, etc. The GitHub render doesn't seem to choke so this was the easiest solution.

Although, this fix works locally but doesn't seem to work on the runner. Grrrr...

[  85/1111] notebooks/quickstart/quickstart_model_documentation.Rmd
ERROR: Error executing 'Rscript': Failed to spawn 'Rscript': entity not found
Unable to locate an installed version of R.
Install R from https://cloud.r-project.org/
WARN: Error encountered when rendering files

Dependencies, breaking changes, and deployment notes

Relies on being merged in https://github.com/validmind/release-notes/pull/71.

Release notes

n/a

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 Mar 27, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Mar 27, 2026
Copy link
Copy Markdown
Collaborator Author

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

REMOVE THE REF IN THE WORKFLOW BEFORE MERGING!!!

EDIT: No longer relevant, removed.

@validbeck validbeck requested a review from nrichers March 27, 2026 19:54
@validbeck validbeck force-pushed the beck/sc-15412/release-notes-filter-listing-pages-by-category branch from 05ba51d to c69486a Compare March 30, 2026 20:14
@validbeck validbeck force-pushed the beck/sc-15412/release-notes-filter-listing-pages-by-category branch from a87523b to c69486a Compare March 31, 2026 19:17
@validbeck
Copy link
Copy Markdown
Collaborator Author

@nrichers I do still need approval for this as this fixes:

  • Broken links to the old breaking changes and deprecations page
  • The issue with the .Rmd files breaking local renders

@validbeck validbeck changed the title release preview: Filter listing pages by category docs fixes: Remove old breaking changes/deprecrations from releases & ignore .Rmd in Quarto renders Mar 31, 2026
Copy link
Copy Markdown
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM!

validbeck and others added 2 commits March 31, 2026 15:09
Co-authored-by: Nik Richers <nik@validmind.ai>
@github-actions
Copy link
Copy Markdown
Contributor

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: 9e8833e

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.68 1.00 0.82
/get-started/get-started.html 0.85 0.75 1.00 0.73
/guide/guides.html 0.81 0.67 1.00 0.82
/index.html 0.93 0.67 1.00 0.82
/releases/all-releases.html 0.86 0.68 1.00 0.73
/support/support.html 0.91 0.67 1.00 0.82
/training/training.html 0.85 0.68 0.96 0.73

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

PR Summary

This pull request updates the recommended Python version across multiple documentation files and notebooks from "Python 3.8 <= x <= 3.11" to "Python 3.8 <= x <= 3.14". The changes span several file formats including Quarto Markdown (.qmd), Jupyter Notebook (.ipynb), and R Markdown (.Rmd), ensuring consistency in the recommended Python version across the platform.

Other functional modifications include:

  • Adding a copyright and SPDX license header to the breaking changes document to ensure proper licensing information is included.
  • Adjusting rendering settings in the site configuration to include additional file types (*.qmd, *.ipynb, *.md).
  • Updating a release notes link to point to the new breaking changes and deprecations page.

These updates ensure that the documentation and code examples align with the supported Python version range and that licensing information is clearly propagated throughout the project.

Test Suggestions

  • Run all documentation notebooks to ensure they execute without errors using Python 3.14.
  • Verify that the rendered website (using Quarto) includes the newly added file patterns.
  • Confirm that the updated release notes link navigates to the correct breaking changes page.

@validbeck
Copy link
Copy Markdown
Collaborator Author

@nrichers FYI, what I ended up doing instead was this in _quarto.yml (no need for the .quartoignore) and it also fixed the workflow issue:

project:
  type: website
  render:
    - "**/*.qmd"
    - "**/*.ipynb"
    - "**/*.md"

(This should also remove the need for you to add the files to the .gitignore in #1256.)

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Apr 1, 2026

Validate docs site

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

@validbeck validbeck merged commit 91b7208 into main Apr 1, 2026
5 of 7 checks passed
@validbeck validbeck deleted the beck/sc-15412/release-notes-filter-listing-pages-by-category branch April 1, 2026 01:14
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