Merge staging into prod by nrichers · Pull Request #1235 · validmind/documentation

nrichers · 2026-03-23T20:24:08Z

Pull Request Description

What and why?

Merge staging into prod for testing Quart 1.9.36.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

…1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread

PR#1202 — Merge main into staging

…tom-artifact-types-in Docs: Clarify custom artifact types

…ments & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights

PR#1207 — Merge main into staging

* WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Fixing numbering * Fixing indenting --------- Co-authored-by: Nik Richers <nik@validmind.ai>

PR#1206 — Merge main into staging

feat: docs pipeline to render markdown

PR#1210 — Merge main into staging

…1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module

PR#1211 — Merge main into staging

feat: make llm publishing slimmer- no release no installation no library

PR#1214 — Merge main into staging

PR#1163 — Merge main into staging

* WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit

PR#1224 — Merge main into staging

* WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo

PR#1228 — Merge main into staging

* Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

PR#1227 — Merge main into staging

PR#1231 — Merge main into staging

github-actions · 2026-03-23T20:25:07Z

PR Summary

This PR introduces widespread terminology updates across the repository to better align with product terminology. In many files—including GitHub workflows, Quarto templates, training materials, and Jupyter notebooks—the term “Documentation” has been replaced with “Development” for model documentation, and “Validation Report” has been simplified to “Validation”. Similarly, references to ongoing monitoring have been updated to use the term “Monitoring” or “Monitoring report”. Other textual changes include updating references such as "Documentation templates" to "Document templates" and adjustments in labels to ensure consistency across the UI (for example, in the sidebar and in code snippet retrieval instructions). These systematic changes affect code comments, configuration YAML files, training and use-case notebooks, and various markdown pages, aiming to streamline both the developer and end-user experience on the ValidMind Platform.

The functional behavior remains unchanged; the changes are purely renaming and label adjustments to improve clarity and consistency in the user interface and documentation.

Test Suggestions

Manually verify that all sidebar labels and navigation items now display ‘Development’, ‘Validation’, and ‘Monitoring’ in place of their previous names.
Review the rendered output of Quarto documents and training materials to ensure that the updated terminology is correctly applied.
Run the workflows (e.g. deploy-docs-prod.yaml, publish-llm-markdown.yaml) to confirm that token names and file path updates do not affect functionality.
Check that code snippet retrieval instructions in the app and training slides correctly reflect the new options in the document drop-down menus.

github-actions · 2026-03-23T20:45:00Z

Execute training notebooks for PRs

✓ INFO: Live previews are available —

github-actions · 2026-03-23T20:46:02Z

Validate docs site

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

github-actions · 2026-03-23T20:48:50Z

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: 05eb22c

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.70	1.00	0.82
/get-started/get-started.html	0.85	0.70	1.00	0.73
/guide/guides.html	0.81	0.69	1.00	0.82
/index.html	0.93	0.66	1.00	0.82
/releases/all-releases.html	0.86	0.70	1.00	0.73
/support/support.html	0.91	0.68	1.00	0.82
/training/training.html	0.85	0.64	0.96	0.73

* Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

PR#1230 — Merge main into staging

* Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref

PR#1166 — Merge main into staging

* Setup: Export analytics * WIP * edit * Proofreading

PR#1225 — Merge main into staging

* Expand custom artifact type content * Add margin footnote link * Change to definition list * Edits * docs: Organization wide default tracking changes in content blocks (#1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread * docs: Insert inventory & artifact field values as variables into documents & library blocks (#1207) * Save point * Save point * Work with content blocks > Reference field values * Single-source prep * Editing * Save point * Save point * Save point * Edit * Editing... * New content editing toolbar image * Missing copyrights * docs: Individual model inventory field activity (#1206) * WIP: View model activity > Filter all model activity * Save point * View model activity: View individual model field activity * Save point * Save point * Save point * Proofreading * Proofreading again * Typo * Update site/guide/model-inventory/edit-model-inventory-fields.qmd * Fixing numbering * Fixing indenting --------- * feat: docs pipeline to render markdown * feat: bump quarto to pre-release * chore: run llm gen at the end so we don't delay pr previews * LUA filter + Pandoc post-processing experiment * docs: 'document' parameter in `vm.init()` for model document target (#1211) * WIP * Save point * Save point * Save point * Edit: Install & initialize the ValidMind Library * Cursor WIP * Save point * Save point * Save point * Save point * Save point * Store model credentials in env files * What's next * Updating notebook listing scripts for page-size: 4 * Save point * Quick edit * One more * and another * Hang on forgot training stuff * Updated get started * Updated enable monitoring * Training updated * copyright * Missed a module * feat: make llm publishing slimmer- no release no installation no library * chore: put vm-library llm docs back * Switch to sparse checkout for some repos * fix: errors in publish llm gha * chore: handle the case where branch name is not main or prod, for instance when testing * Add "Quick reference" section to test overview page (#1205) * Add key concepts section to test overview page * Make section a callout, change to quick reference * Save point for graphviz * Some graphviz tweaks * A few more tweaks * Fill colour tweak * Document vm_today and datetime support in calculated fields (#1167) * Document vm_today and datetime support in calculated fields Add collapsible example for date arithmetic in model inventory calculation fields: vm_today, date, datetime, timedelta, relativedelta. Includes next review date and days-remaining countdown examples. Notes timestamp input and string output behavior. [sc-7465] * Fix whitespace * Fix heading level and move inventory field types up one section * Add screenshots, edits after testing * Save point before moving content * Move into its own file and relocate * Better intro * Restore better vm_today example * Edits * Minor text reschuffle * Mention fields by name * Move field types reference content below prequisites and bump to h2 * Fix example casing * Consistency edit * Rename and restructure Supported Models page (#1163) * Rename and restructure Supported Models page - Rename supported-models.qmd to supported-model-frameworks.qmd - Add alias for old URL to preserve links - Restructure content into clearer sections: - Framework support with wrapper classes and install commands - Test input requirements (predict vs predict_proba) - Custom model wrappers (FunctionModel, PipelineModel) - GenAI and LLM support - RAG evaluation with RAGAS - Python and dependency compatibility - Add Mermaid diagrams for class hierarchy and test input flow - Update references in faq-integrations.qmd and overview-model-documentation.qmd * Fix missed sidebar update * Fix broken link * Add bridging sentence after callout * Re-add a what does supported mean heading * Minor edit * Re-add some old goodness * Much better detail * Edits * More edits * Edits * Remove old supported models page * Minor edit * Edits * File rename again * Remove duplicated embeddings content * Uncomment and move info about tests for text-generating models * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Update site/developer/supported-models-and-frameworks.qmd * Switch to definition list after removing lead-in text for bulleted list * Two columns for a neater layout * Remove pointless link * Add links, text edits * Update site/developer/supported-models-and-frameworks.qmd * Whitespace * Address review comment from Juan * Remove links I'd added --------- * docs: Updated document type names (#1224) * WIP * WIP * Editing validation report template def * Edit... * Glossary / about updated * FAQ updated * Quickstart -screenshots updated * Work with test results done * Enable monitoring done * Review monitoring results done * Work with metrics over time done * save point * save point * Editing Export documents * Export documents done * Glossary proofreading * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Save point * Edit Manage document types * Edit Manage model documents * Edit Customize document templates * Edit Manage document templates * Edit Export documents * Edit * Edit * Quickstart - Register a model * Quickstart - Select a template * Quickstart - Work with {document} * Proofread * Pulling in latest notebooks * Removing unused page * Removing backup screenshots * Revert "Removing unused page" This reverts commit 9a710fd. * Revering a change that didn't make sense * Updating notebooks again * edit * docs: Delete and archive artifact types (#1228) * WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo * Add R support documentation (#1227) * Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- * Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231) * Fix CI hang: Don't try to render Graphviz diagrams with GFM (#1230) * Add pandoc install step * Try chromium install since stuff renders fine locally * Switch to RELEASE_NOTES_RO_PAT for installation repo * Try images instead of Graphviz * Add render-llm make action for local testing * Remove Chromium install steps * BG transparency --------- * Add auto-generated template schema documentation (#1166) * Add auto-generated template schema documentation - Create generate_template_schema_docs.py script to generate HTML schema docs from backend JSON Schema using json-schema-for-humans - Update customize-document-templates.qmd to use generated include - Add template schema and permissions documentation sections to README.md The template schema is now regenerated from the v5 JSON schema in the backend repo, replacing the outdated hardcoded HTML. Closes sc-6164 * Switch to {html} codeblock, move styles into separate file, style tweaks * Fixed whitespace issue and added rounded corners * Fix heading level * Delete generated template schema file * Add make action and move template schema docs generation into workflows * Minor edit * Fix style for No Additional Items badges * Kibosh wayward ellipsis * Remove permissions documentation section from my other PR * Strip out schema doc CSS that causes issues, style tweaks * Move expand and collapse buttons above first accordion * Smidgen of whitespace before embed * Add README.md section of required repos, remove old R info * Temporarily add Andres' branch ref * Switch to new UI schema JSON * Remove temporary branch ref * docs: Export analytics (#1225) * Setup: Export analytics * WIP * edit * Proofreading --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Spencer Krum <nibz@validmind.ai>

nrichers and others added 30 commits March 4, 2026 10:23

Expand custom artifact type content

897e7a2

Add margin footnote link

6c279e9

Change to definition list

f123f54

Edits

e776f27

docs: Organization wide default tracking changes in content blocks (#…

df2cbed

…1202) * Edit: Managing your organization * WIP: Collaborate with others > Tracking changes * Edit: Collaborate with others > Tracking changes * Proofread

Merge remote-tracking branch 'origin/main' into staging

c4b53b3

Merge pull request #1203 from validmind/update-staging-22699681673

66e56ad

PR#1202 — Merge main into staging

Merge pull request #1201 from validmind/nrichers/sc-14980/clarify-cus…

e17f09a

…tom-artifact-types-in Docs: Clarify custom artifact types

Merge remote-tracking branch 'origin/main' into staging

78351e0

Merge remote-tracking branch 'origin/main' into staging

8601803

Merge pull request #1208 from validmind/update-staging-22791881768

a0d252a

PR#1207 — Merge main into staging

Merge remote-tracking branch 'origin/main' into staging

1a1ec56

Merge pull request #1209 from validmind/update-staging-22870794949

8ba1fc1

PR#1206 — Merge main into staging

feat: docs pipeline to render markdown

b9eb08d

feat: bump quarto to pre-release

88ad920

chore: run llm gen at the end so we don't delay pr previews

d93a6fc

LUA filter + Pandoc post-processing experiment

1b6d8f5

Merge pull request #1210 from validmind/nibz/generate_markdown

7cb61cd

feat: docs pipeline to render markdown

Merge remote-tracking branch 'origin/main' into staging

4492792

Merge pull request #1212 from validmind/update-staging-22931215889

c39c70a

PR#1210 — Merge main into staging

Merge remote-tracking branch 'origin/main' into staging

e38589e

Merge pull request #1213 from validmind/update-staging-22934264603

4e5c712

PR#1211 — Merge main into staging

feat: make llm publishing slimmer- no release no installation no library

80668d0

chore: put vm-library llm docs back

e797529

Merge pull request #1214 from validmind/nibz/simpler_llm

da0b26b

feat: make llm publishing slimmer- no release no installation no library

Merge remote-tracking branch 'origin/main' into staging

a341ce2

Merge pull request #1215 from validmind/update-staging-22966578607

1312464

PR#1214 — Merge main into staging

github-actions bot and others added 14 commits March 17, 2026 23:54

Merge remote-tracking branch 'origin/main' into staging

f6d490d

Merge pull request #1223 from validmind/update-staging-23222022781

44042b6

PR#1163 — Merge main into staging

Merge remote-tracking branch 'origin/main' into staging

2013f72

Merge pull request #1226 from validmind/update-staging-23310015653

00a554d

PR#1224 — Merge main into staging

docs: Delete and archive artifact types (#1228)

f9b1a95

* WIP * WIP * Edit: Manage artifact types * Edit * Edit after Slack convo

Merge remote-tracking branch 'origin/main' into staging

a93a5ae

Merge pull request #1229 from validmind/update-staging-23360309350

0b22f53

PR#1228 — Merge main into staging

Add R support documentation (#1227)

8cdaf9a

* Initial draft * Add more install info * Add quickstarts * Grouping install & initalize in sidebar * Silly sidebar variable quirk --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>

Merge remote-tracking branch 'origin/main' into staging

8a8b1eb

Merge pull request #1232 from validmind/update-staging-23453342946

eb571ba

PR#1227 — Merge main into staging

Switch to RELEASE_NOTES_RO_PAT for installation repo (#1231)

9634dbf

Merge remote-tracking branch 'origin/main' into staging

81f4df6

Merge pull request #1234 from validmind/update-staging-23455571062

2ede0b3

PR#1231 — Merge main into staging

nrichers added the internal Not to be externalized in the release notes label Mar 23, 2026

nrichers and others added 9 commits March 23, 2026 18:50

Merge remote-tracking branch 'origin/main' into staging

ed5139b

Merge pull request #1236 from validmind/update-staging-23469215126

d36c7d7

PR#1230 — Merge main into staging

Merge remote-tracking branch 'origin/main' into staging

b314c56

Merge pull request #1237 from validmind/update-staging-23499603755

a3a2787

PR#1166 — Merge main into staging

docs: Export analytics (#1225)

d9fd1e2

* Setup: Export analytics * WIP * edit * Proofreading

Merge remote-tracking branch 'origin/main' into staging

83b86ef

Merge pull request #1238 from validmind/update-staging-23502076998

d1c1499

PR#1225 — Merge main into staging

nrichers merged commit 502bc22 into prod Mar 24, 2026
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Merge staging into prod#1235

Merge staging into prod#1235
nrichers merged 70 commits intoprodfrom
staging

nrichers commented Mar 23, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

github-actions bot commented Mar 23, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

nrichers commented Mar 23, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Description

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

Uh oh!

github-actions bot commented Mar 23, 2026

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Mar 23, 2026

Execute training notebooks for PRs

Uh oh!

github-actions bot commented Mar 23, 2026

Validate docs site

Uh oh!

github-actions bot commented Mar 23, 2026

Lighthouse check results

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

nrichers commented Mar 23, 2026 •

edited

Loading