docs: Updated document type names by validbeck · Pull Request #1224 · validmind/documentation

validbeck · 2026-03-18T20:22:24Z

Pull Request Description

What and why?

sc-14434

We renamed our core document types. Documentation, when discussing the type of document rather than the concept of the document (for example, Development type document vs model documentation) has been adjusted in the product documentation and the notebooks pulled into the documentation to match.

Other major updates:

Glossary

The old generic "documentation template" and "validation report template" glossary entries were replaced with expanded, specific definitions for three default document types:

documentation template
validation report template
monitoring template (new entry)

OLD	NEW

Export documents

Simplified page that now includes the ability to export custom document types:

OLD	NEW
old-export-documents.mov	new-export-documents.mov

How to test

Spot check the live previews of the changed pages (major updates are bolded):

About

Use cases:

AI governance:
- EU AI Act
Model risk management:
- SR 11-7
- SS1/23
- E-23

Product features:

Library and platform:
- Deployment options
Glossary

Get Started

Major updates to screenshots:

Guides

Guides

Model inventory:

View model activity

Templates:

Working with model documents:
- Manage document types
- Manage model documents
Working with document templates:
- Customize document templates
- Manage document templates
Manage text block library

Model documentation:

Working with model documentation:

Model validation:

Managing model validation:
- Manage validation guidelines
- Configure assessment options
Preparing validation reports:
- Assess compliance
Working with artifacts:
- Add and manage artifacts

Reporting:

Generating exports:
- Export documents

Monitoring:

Ongoing monitoring:

FAQ

FAQ

Training

Administrator Fundamentals

Customizing Your Model Inventory:

Developer Fundamentals

Using ValidMind for Model Development:
- Apply a documentation template
- Verify the documentation template
Learning to Run Tests:
- Work with test results
Implementing Custom Tests:
- Custom test results
- Insert custom test-driven blocks
Finalizing Model Documentation:

Validator Fundamentals

Using ValidMind for Model Validation:
Running Data Quality Tests:
- Link validator evidence
Developing Challenger Models:
- Create a validation issue
Finalizing Validation Reports:

What is ValidMind?

What is ValidMind?

AI Governance

Managing AI Use Cases
Compliance and Oversight:

What needs special review?

Important

I left the table on "Manage permissions" untouched as that page is very outdated and references a super old document permission schema. This page is already being updated by sc-5927.

Dependencies, breaking changes, and deployment notes

I already pulled in the latest notebooks updated by me in validmind/validmind-library#486. Any future calls of make get-source will need to checkout notebooks to documentation repo main to ensure updates remain until we are caught up with a new release.

Release notes

Covered by https://github.com/validmind/frontend/pull/2244.

Checklist

…s-documentation

This reverts commit 9a710fd.

github-actions · 2026-03-18T21:51:41Z

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: 96bab96

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

even-steven

Looks good @validbeck 👍🏽

github-actions · 2026-03-19T17:05:53Z

PR Summary

This PR makes systematic changes across the project’s content pages, FAQs, guides, tutorials, and training documentation. The updates standardize the terminology by replacing terms such as "Documentation" with "Documents" and "Documentation templates" with "Document templates." Similar changes include updating phrases like "Documentation & templates" to "Documents & templates" and ensuring consistency for related product elements (e.g., use of "Development" and "Validation" for document type selectors). These changes are spread across multiple files including Quarto files, markdown files, and notebooks. The goal is to reflect product updates and ensure consistency in how users refer to the documents, templates, and reporting sections throughout the platform.

In addition, minor modifications include updating section titles (e.g., from "Ongoing Monitoring" to "Ongoing Monitoring reports") and adjusting anchors and category tags to match the new naming conventions. Overall, the changes improve the clarity and consistency of the product documentation while aligning terminology with recent product updates.

Test Suggestions

Manually navigate the website and training documentation to verify that all references to 'Documentation' have been replaced by 'Documents'.
Check that the document templates displayed in the UI and within the platform correctly reflect the new naming conventions (e.g., 'Document templates' vs 'Documentation templates').
Run existing automated integration tests for the static site build to ensure that no links or anchors are broken.
Review sample notebooks to confirm that code snippets and instructions correctly refer to the updated terms (Development/Validation instead of Documentation/Validation Report).

github-actions · 2026-03-19T17:26:13Z

Validate docs site

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

github-actions · 2026-03-19T18:11:02Z

Execute training notebooks for PRs

✓ INFO: Live previews are available —

* 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 Co-authored-by: Nik Richers <nik@validmind.ai> * Fixing numbering * Fixing indenting --------- Co-authored-by: Nik Richers <nik@validmind.ai> * 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 Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Update site/developer/supported-models-and-frameworks.qmd Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * 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 Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * Whitespace * Address review comment from Juan * Remove links I'd added --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * 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 --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * 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 --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * 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>

* 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>

validbeck added 30 commits March 17, 2026 09:49

WIP

4b1a8d8

WIP

bdd0edb

Editing validation report template def

ef648d9

Edit...

031dcc9

Glossary / about updated

4f7c778

FAQ updated

82f27de

Quickstart -screenshots updated

01b56d0

Work with test results done

30a4032

Enable monitoring done

8a8202d

Review monitoring results done

9b38db6

Work with metrics over time done

58ec0e9

save point

956a1ad

save point

3124494

Editing Export documents

3e8eeed

Export documents done

5740622

Glossary proofreading

c269106

Save point

4e0ffda

Save point

633efc2

Save point

35e9173

Save point

716300a

Save point

7473bb4

Save point

134a8b7

Save point

f32d59e

Save point

88a7e00

Edit Manage document types

a22e4a6

Edit Manage model documents

67280d2

Edit Customize document templates

fed88bd

Edit Manage document templates

2c2006f

Edit Export documents

1053f6e

Edit

daa2841

validbeck added 8 commits March 18, 2026 11:51

Edit

3513766

Quickstart - Register a model

49210fd

Quickstart - Select a template

9d5660d

Quickstart - Work with {document}

0935dc8

Proofread

5b481b5

Pulling in latest notebooks

f8c919e

Removing unused page

9a710fd

Merge 'main' into beck/sc-14434/docs-update-document-type-names-acros…

bd5c1e4

…s-documentation

validbeck self-assigned this Mar 18, 2026

validbeck added the internal Not to be externalized in the release notes label Mar 18, 2026

validbeck added 3 commits March 18, 2026 13:52

Removing backup screenshots

f367918

Revert "Removing unused page"

da29719

This reverts commit 9a710fd.

Revering a change that didn't make sense

5941991

validbeck requested review from even-steven and nrichers March 18, 2026 22:01

Updating notebooks again

910e6be

even-steven approved these changes Mar 19, 2026

View reviewed changes

edit

39c3c43

validbeck merged commit e4a3914 into main Mar 19, 2026
5 of 8 checks passed

validbeck deleted the beck/sc-14434/docs-update-document-type-names-across-documentation branch March 19, 2026 18:14

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Updated document type names#1224

docs: Updated document type names#1224
validbeck merged 43 commits intomainfrom
beck/sc-14434/docs-update-document-type-names-across-documentation

validbeck commented Mar 18, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 18, 2026

Uh oh!

even-steven left a comment

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

github-actions bot commented Mar 19, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

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

Uh oh!

Pull Request Description

What and why?

Glossary

Export documents

How to test

About

Get Started

Guides

FAQ

Training

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

Uh oh!

github-actions bot commented Mar 18, 2026

Lighthouse check results

Uh oh!

even-steven left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 19, 2026

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Mar 19, 2026

Validate docs site

Uh oh!

github-actions bot commented Mar 19, 2026

Execute training notebooks for PRs

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

validbeck commented Mar 18, 2026 •

edited

Loading