docs: Models > Records — Developer portal, quickstarts, & training

[validbeck]

Pull Request Description

Warning

BECK REMOVE THE BRANCH REF TO THE RELEASE-NOTES IN THE PR WORKFLOW BEFORE MERGING!!!

What and why?

sc-15850

Continuing the work for primary record types (models > records etc.). This PR covers more updates in the ValidMind Library, Get Started, and ValidMind Academy (training) sections of the documentation. Pulls in the updated notebooks from validmind/validmind-library#509.

Important

THIS PR IS NOT EXHAUSTIVE DUE TO THE LARGE SCOPE OF WORK. Refer to "What needs special review?" for follow-on updates.

How to test

Click on the live previews and review the content:

Get started

OLD	NEW
Quickstart — Model Development	Quickstart — Development
Quickstart — Model Validation	Quickstart — Validation

ValidMind Library

OLD	NEW
ValidMind Library	ValidMind Library
Supported models and frameworks	Supported records and frameworks
Code samples	Code samples
Test descriptions	Test descriptions

Quickstart

OLD	NEW
Install and initialize the ValidMind Library	Install and initialize the ValidMind Library
Install and initialize ValidMind for R	Install and initialize ValidMind for R
Use an HTTP proxy with the ValidMind Library	Use an HTTP proxy with the ValidMind Library
Store model credentials in .env files	Store record credentials in .env files

How To

OLD	NEW
How to run tests and test suites	How to run tests and test suites

Training

OLD	NEW
ValidMind Academy	ValidMind Academy

Program

OLD	NEW
Learn with confidence	Learn with confidence
Learning paths	Learning paths
Where do I find … ?	Where do I find … ?

Developer Fundamentals

OLD	NEW
Developer Fundamentals	Developer Fundamentals
Using ValidMind for Model Development	Using ValidMind for Development
Learning to Run Tests	Learning to Run Tests
Implementing Custom Tests	Implementing Custom Tests
Finalizing Model Documentation	Finalizing Documentation

Validator Fundamentals

OLD	NEW
Validator Fundamentals	Validator Fundamentals
Using ValidMind for Model Validation	Using ValidMind for Validation
Running Data Quality Tests	Running Data Quality Tests
Developing Challenger Models	Developing Potential Challengers
Finalizing Validation Reports	Finalizing Validation Reports

What Is ValidMind

OLD	NEW
What is ValidMind?	What is ValidMind?

What needs special review?

Still lots of updates that need to be made to the docs as this new functionality is pretty all-encompassing.

What's not covered and will be in future Stories (not using the sc link so the GitHub integration doesn't think these Stories are under review due to this PR being linked):

• 15995: Remaining updates to "Guides", update of "Administrator Fundamentals" training
• 15992: Updates to the "About" and "Support" sections of the docs site (including key concepts)

Release notes

n/a

Dependencies, breaking changes, and deployment notes

• Notebooks pulled into JupyterHub here (needs a quick deploy): https://github.com/validmind/demo-environment/pull/28
• Notebooks pulled from library here: notebooks: PRT work pt1 validmind-library#509
• Release notes PR for fixed broken links: https://github.com/validmind/release-notes/pull/80

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)

[jamadriz]

Blockers / should fix before merge

1. Branch is behind main and would revert Starlark calculated-field docs

The branch is 1 commit behind main (likely #1323 — Calculated fields formula reference). Merging as-is would remove the Starlark helper table and guidance from site/guide/inventory/_field-types.qmd and roll examples back to params.materiality dot notation instead of params["materiality"].

main last touched that file: 99b05d4
PR branch last touched it: b91c76c (older records phase II work)
Action: Rebase or merge main into the branch and keep the Starlark content from #1323 while applying only the intentional record-type wording changes from this PR.

2. Typo introduced in validation quickstart shared include

In _register-your-first-model.qmd, the validator path says recird owner instead of record owner:

_register-your-first-model.qmd
Lines 57-57
a. Select your own name under the [recird owner]{.smallcaps} drop-down — don't worry, we'll adjust these permissions next for validation.
The developer path correctly uses record owner. This typo was introduced in this PR’s diff.

3. Lighthouse accessibility check failed

lighthouse failed with average accessibility 0.87 (threshold > 0.9). Other checks passed. Worth confirming whether new/changed pages introduced regressions or if this is a known baseline issue before merge.

[validbeck]

@jamadriz ty for the review! Notes:

1. Branch is behind main and would revert Starlark calculated-field docs

The branch is 1 commit behind main (likely #1323 — Calculated fields formula reference). Merging as-is would remove the Starlark helper table and guidance from site/guide/inventory/_field-types.qmd and roll examples back to params.materiality dot notation instead of params["materiality"].

main last touched that file: 99b05d4 PR branch last touched it: b91c76c (older records phase II work) Action: Rebase or merge main into the branch and keep the Starlark content from #1323 while applying only the intentional record-type wording changes from this PR.

Up to date with main now (commit #9a92167), not sure what conflict it was talking about as it seems fine.

2. Typo introduced in validation quickstart shared include

In _register-your-first-model.qmd, the validator path says recird owner instead of record owner:

_register-your-first-model.qmd Lines 57-57 a. Select your own name under the [recird owner]{.smallcaps} drop-down — don't worry, we'll adjust these permissions next for validation. The developer path correctly uses record owner. This typo was introduced in this PR’s diff.

Fixed in commit #d57d216.

3. Lighthouse accessibility check failed

lighthouse failed with average accessibility 0.87 (threshold > 0.9). Other checks passed. Worth confirming whether new/changed pages introduced regressions or if this is a known baseline issue before merge.

This is a known issue, Nik is working on it in #1333.

[github-actions]

Validate docs site

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

[github-actions]

Execute training notebooks for PRs

✓ INFO: Live previews are available —

• Open development series
• Open validation series

[github-actions]

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: 045c81a

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.71	1.00	0.73
/guide/guides.html	0.85	0.69	1.00	0.82
/index.html	0.93	0.69	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.63	0.96	0.73