docs & training: Calculation Finding Fields #988

validbeck · 2025-10-09T19:42:09Z

Pull Request Description

What and why?

sc-12675

Findings now have Calculation field types where you can define formulas. I added this to the findings fields customization instructions, and added the updated finding fields customization instructions to the introductory administrative/setup training course.

How to test

Click the live previews:

Manage model finding fields — SCROLL DOWN TO Calculation HEADER
Customizing Your Model Inventory (Administrator Fundamentals module 2):
- Manage model finding fields
- Add a finding field

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

n/a

Release notes

Covered in the wrap-up: https://github.com/validmind/release-notes/pull/29

Checklist

github-actions · 2025-10-09T19:43:08Z

Vale source linter

⚠️ WARN: Found 14297 issues across 692 files — Check the workflow run or download the full report

Show first 30 files with issues

site/404.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 3: Did you really mean 'html'? (error)
Line 53: Did you really mean 'const'? (error)
Line 53: Use parentheses judiciously. (suggestion)
Line 54: Did you really mean 'const'? (error)
Line 54: Did you really mean 'ctx'? (error)
Line 54: Use parentheses judiciously. (suggestion)
Line 54: Put a nonbreaking space between the number and the unit in '2d'. (error)
Line 58: Did you really mean 'const'? (error)
Line 58: Did you really mean 'fontSize'? (error)
... and 23 more issues

site/about/contributing/style-guide/conventions.qmd

Line 6: Use 'it's' instead of 'it is'. (suggestion)
Line 6: In general, use active voice instead of passive voice ('is received'). (suggestion)
Line 6: Use parentheses judiciously. (suggestion)
Line 9: Use 'capability' or 'feature' instead of 'functionality'. (warning)
Line 9: Use 'shouldn't' instead of 'should not'. (suggestion)
Line 9: In general, use active voice instead of passive voice ('be lost'). (suggestion)
Line 15: Did you really mean 'Palo'? (error)
Line 19: Avoid using 'will'. (warning)
Line 19: In general, use American spelling instead of 'centre'. (warning)
Line 19: Avoid using 'will'. (warning)
... and 180 more issues

site/about/contributing/style-guide/style-guide.qmd

Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Try to avoid using first-person plural like 'We'. (warning)
Line 24: Try to avoid using first-person plural like 'Our'. (warning)
Line 24: Try to avoid using first-person plural like 'our'. (warning)
... and 13 more issues

site/about/contributing/style-guide/voice-and-tone.qmd

Line 6: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'our'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 8: Try to avoid using first-person plural like 'we'. (warning)
Line 18: Avoid using 'will'. (warning)
Line 18: In general, use active voice instead of passive voice ('be reviewed'). (suggestion)
Line 22: Use parentheses judiciously. (suggestion)
Line 22: Try to avoid using first-person plural like 'we'. (warning)
Line 22: Don't put a space before or after a dash. (error)
... and 39 more issues

site/about/contributing/validmind-community.qmd

Line 8: Use parentheses judiciously. (suggestion)
Line 8: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
Line 8: Try to avoid using first-person plural like 'our'. (warning)
Line 8: Don't use exclamation points in text. (error)
Line 8: Try to avoid using first-person plural like 'us'. (warning)
Line 14: Try to avoid using first-person plural like 'our'. (warning)
Line 19: Don't use exclamation points in text. (error)
Line 25: Use parentheses judiciously. (suggestion)
Line 31: Try to avoid using first-person plural like 'our'. (warning)
Line 42: Use parentheses judiciously. (suggestion)
... and 37 more issues

site/about/deployment/_deployment-available-options.qmd

Line 1: Try to avoid using first-person plural like 'Our'. (warning)
Line 1: Use parentheses judiciously. (suggestion)
Line 1: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
Line 3: Try to avoid using first-person plural like 'We'. (warning)
Line 5: Don't put a space before or after a dash. (error)
Line 5: Use parentheses judiciously. (suggestion)
Line 5: In general, use active voice instead of passive voice ('be established'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)
Line 7: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
Line 7: Don't put a space before or after a dash. (error)
... and 1 more issues

site/about/deployment/deployment-options.qmd

Line 24: Use parentheses judiciously. (suggestion)
Line 26: Use 'Google Cloud Platform' or 'GCP' instead of 'Cloud'. (warning)
Line 28: Try to avoid using first-person plural like 'our'. (warning)
Line 32: Don't put a space before or after a dash. (error)
Line 32: Did you really mean 'validators'? (error)
Line 34: Don't put a space before or after a dash. (error)
Line 36: Don't put a space before or after a dash. (error)
Line 38: Don't put a space before or after a dash. (error)
Line 42: Try to avoid using first-person plural like 'We'. (warning)
Line 42: Use 'data is' instead of 'data are'. (warning)
... and 12 more issues

site/about/deployment/multi-tenant-cloud.qmd

Line 13: Use 'tap' instead of 'touch'. (warning)
Line 17: Did you really mean 'deployment_'? (error)
Line 19: Use 'it's' instead of 'it is'. (suggestion)
Line 21: Use parentheses judiciously. (suggestion)
Line 29: Don't put a space before or after a dash. (error)
Line 30: Don't put a space before or after a dash. (error)
Line 31: Don't put a space before or after a dash. (error)
Line 32: Don't put a space before or after a dash. (error)
Line 39: In general, use active voice instead of passive voice ('is encrypted'). (suggestion)
Line 40: Use parentheses judiciously. (suggestion)
... and 2 more issues

site/about/deployment/system-access-requirements.qmd

Line 10: Try to avoid using first-person plural like 'our'. (warning)
Line 10: Did you really mean 'validators'? (error)
Line 16: Spell out 'REST', if it's unfamiliar to the audience. (suggestion)
Line 24: Use 'app' instead of 'application'. (warning)
Line 26: Use 'app' instead of 'application'. (warning)
Line 32: Use 'import' or 'load' instead of 'ingest'. (warning)

site/about/deployment/virtual-private-validmind.qmd

Line 2: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'TITLE', if it's unfamiliar to the audience. (suggestion)
Line 2: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 3: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
Line 14: Use 'tap' instead of 'touch'. (warning)
Line 18: Use parentheses judiciously. (suggestion)
Line 18: Spell out 'VPV', if it's unfamiliar to the audience. (suggestion)
... and 8 more issues

site/about/fine-print/data-privacy-policy.qmd

Line 12: Try to avoid using first-person plural like 'our'. (warning)
Line 19: Try to avoid using first-person plural like 'we'. (warning)
Line 21: Try to avoid using first-person plural like 'Our'. (warning)
Line 21: Try to avoid using first-person plural like 'our'. (warning)
Line 21: Try to avoid using first-person plural like 'our'. (warning)
Line 26: Try to avoid using first-person plural like 'our'. (warning)
Line 26: Try to avoid using first-person plural like 'we'. (warning)
Line 26: Try to avoid using first-person plural like 'our'. (warning)
Line 34: Use 'what's' instead of 'What is'. (suggestion)
Line 36: Try to avoid using first-person plural like 'our'. (warning)
... and 49 more issues

site/about/fine-print/license-agreement.qmd

Line 9: Spell out 'READ', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Spell out 'THIS', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'USING', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'THE', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'YOU', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'ARE', if it's unfamiliar to the audience. (suggestion)
... and 115 more issues

site/about/glossary/_ai.qmd

Line 1: Spell out 'IBM', if it's unfamiliar to the audience. (suggestion)
Line 1: Use parentheses judiciously. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 7: Use parentheses judiciously. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 10: In general, use active voice instead of passive voice ('were trained'). (suggestion)
Line 12: Use parentheses judiciously. (suggestion)
Line 12: Spell out 'LLM', if it's unfamiliar to the audience. (suggestion)
Line 13: Use parentheses judiciously. (suggestion)

site/about/glossary/_attestation.qmd

Line 2: Did you really mean 'validator'? (error)
Line 2: In general, use active voice instead of passive voice ('are met'). (suggestion)
Line 5: In general, use active voice instead of passive voice ('is triggered'). (suggestion)
Line 14: Did you really mean 'validators'? (error)

site/about/glossary/_developer-tools.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 2: Use 'capability' or 'feature' instead of 'functionality'. (warning)
Line 15: Use 'that's' instead of 'that is'. (suggestion)
Line 20: Try to avoid using first-person plural like 'our'. (warning)
Line 30: Use parentheses judiciously. (suggestion)
Line 32: Use parentheses judiciously. (suggestion)

site/about/glossary/_model-documentation.qmd

Line 1: Spell out 'MODEL', if it's unfamiliar to the audience. (suggestion)
Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_models.qmd

Line 4: Use parentheses judiciously. (suggestion)
Line 7: In general, use active voice instead of passive voice ('are derived'). (suggestion)
Line 7: In general, use active voice instead of passive voice ('is achieved'). (suggestion)
Line 11: Use parentheses judiciously. (suggestion)
Line 15: Use 'it's' instead of 'it is'. (suggestion)
Line 15: In general, use active voice instead of passive voice ('is decommissioned'). (suggestion)
Line 15: Use parentheses judiciously. (suggestion)
Line 22: Use parentheses judiciously. (suggestion)
Line 22: Spell out 'MRM', if it's unfamiliar to the audience. (suggestion)
Line 23: In general, use active voice instead of passive voice ('are developed'). (suggestion)

site/about/glossary/_monitoring.qmd

Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_mrm.qmd

Line 3: Put a nonbreaking space between the number and the unit in '1s'. (error)
Line 3: Spell out all ordinal numbers ('1st') in text. (error)
Line 4: Don't use plurals in parentheses such as in 'unit(s)'. (error)
Line 4: Use parentheses judiciously. (suggestion)
Line 4: Spell out all ordinal numbers ('1st') in text. (error)
Line 4: Put a nonbreaking space between the number and the unit in '1s'. (error)
Line 4: Use 'they're' instead of 'they are'. (suggestion)
Line 6: Spell out all ordinal numbers ('2nd') in text. (error)
Line 7: Spell out all ordinal numbers ('2nd') in text. (error)
Line 7: Did you really mean 'validators'? (error)
... and 11 more issues

site/about/glossary/_validation-reports.qmd

Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 4: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/_validmind-features.qmd

Line 7: In general, use active voice instead of passive voice ('are used'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/_validmind.qmd

Line 3: In general, use active voice instead of passive voice ('are intertwined'). (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 6: Use 'open source' instead of 'open-source'. (warning)
Line 6: Use parentheses judiciously. (suggestion)
Line 6: Did you really mean 'overfit'? (error)
Line 8: Use parentheses judiciously. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Did you really mean 'APIs'? (error)

site/about/glossary/glossary.qmd

Line 7: Spell out 'NEW', if it's unfamiliar to the audience. (suggestion)
Line 7: Spell out 'TERM', if it's unfamiliar to the audience. (suggestion)
Line 7: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 7: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 7: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 9: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)
Line 9: Use parentheses judiciously. (suggestion)
Line 9: Use 'for example' instead of 'e.g.'. (error)
Line 10: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
Line 10: Spell out 'TERMS', if it's unfamiliar to the audience. (suggestion)
... and 9 more issues

site/about/glossary/key_concepts/_docs.qmd

Line 4: Use 'app' instead of 'application'. (warning)

site/about/glossary/key_concepts/_inputs.qmd

Line 2: In general, use active voice instead of passive voice ('be evaluated'). (suggestion)
Line 4: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
Line 4: Use parentheses judiciously. (suggestion)
Line 5: In general, use active voice instead of passive voice ('been initialized'). (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 6: In general, use active voice instead of passive voice ('is used'). (suggestion)
Line 7: In general, use active voice instead of passive voice ('is used'). (suggestion)
Line 7: Use parentheses judiciously. (suggestion)

site/about/glossary/key_concepts/_key-concepts.qmd

Line 1: Spell out 'KEY', if it's unfamiliar to the audience. (suggestion)
Line 1: Spell out 'NEEDS', if it's unfamiliar to the audience. (suggestion)
Line 1: In general, use active voice instead of passive voice ('BE ADDED'). (suggestion)
Line 1: Spell out 'ADDED', if it's unfamiliar to the audience. (suggestion)
Line 3: Use parentheses judiciously. (suggestion)
Line 5: Use parentheses judiciously. (suggestion)
Line 5: Use 'for example' instead of 'e.g.'. (error)
Line 5: Spell out 'ABC', if it's unfamiliar to the audience. (suggestion)

site/about/glossary/key_concepts/_metrics.qmd

Line 2: Use 'don't' instead of 'do not'. (suggestion)
Line 2: In general, use active voice instead of passive voice ('be registered'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be used'). (suggestion)
Line 4: In general, use active voice instead of passive voice ('be thought'). (suggestion)

site/about/glossary/key_concepts/_monitoring-template.qmd

Line 2: In general, use active voice instead of passive voice ('be tracked'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be conducted'). (suggestion)
Line 2: In general, use active voice instead of passive voice ('be displayed'). (suggestion)
Line 4: Did you really mean 'boilerplates'? (error)

site/about/glossary/key_concepts/_outputs.qmd

Line 2: Use parentheses judiciously. (suggestion)
Line 2: 's.D' should have one space. (error)

site/about/glossary/key_concepts/_parameters.qmd

Line 2: In general, use active voice instead of passive voice ('be passed'). (suggestion)

... and 662 more files with issues

nrichers

LGTM, just one minor comment about a button label that differs from what I see in the UI. ✅

Maybe more a comment for @cachafla: should these options be ordered alphabetically or most popular first, followed by an alphabetical list?

site/guide/model-inventory/_field-types.qmd

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

validbeck · 2025-10-09T21:13:32Z

Maybe more a comment for @cachafla: should these options be ordered alphabetically or most popular first, followed by an alphabetical list?

If this changes let me know so I can update the docs.

github-actions · 2025-10-09T21:18:55Z

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: 97c44f3

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.90
/get-started/get-started.html	0.85	0.68	1.00	0.80
/guide/guides.html	0.85	0.71	1.00	0.90
/index.html	0.93	0.68	1.00	0.90
/releases/all-releases.html	0.91	0.68	1.00	0.80
/support/support.html	0.91	0.67	1.00	0.90
/training/training.html	0.82	0.68	0.96	0.80

cachafla · 2025-10-10T15:17:49Z

One small correction in the last formula for findings:

model_criticality = parent_model_params.get("criticality_level", "medium")

Should be:

model_criticality = params.model.get("criticality_level", "medium")

Assuming the user will copy-paste the formula code to test it.

cachafla · 2025-10-10T15:19:06Z

Can the formula codes be re-formatted? They look like this right now:

cachafla

Left a couple of comments but looks good otherwise.

validbeck · 2025-10-10T15:23:17Z

Should be:

model_criticality = params.model.get("criticality_level", "medium")

@cachafla Changed this, thank you! Preview should update in 15min.

EDIT: Merged these changes in:

nrichers · 2025-10-10T15:24:45Z

Can the formula codes be re-formatted? They look like this right now:

We had this issue before, it's a clash of Tachyons and Quarto styles. Will address via sc-12709.

github-actions · 2025-10-10T15:46:51Z

PR Summary

This PR introduces several documentation updates and enhancements for managing inventory and finding fields within the application. Key changes include:

Updated instructions for adding and editing inventory fields to emphasize that the description field is now optional, and that the field type and name are required. The changes also improve the formatting with bold styling for field labels.
Adjustments in the image paths for various field type screenshots to ensure they point to the correct directories.
Reorganization of the content in the model inventory and finding fields guides. The PR moves some content between files and replaces the include reference for inventory field types with a reference to a common field types file, improving consistency between the inventory and validation guides.
Introduction of callouts and code examples in the finding fields documentation, including Python sample formulas for severity score calculations, due date calculations, and combining custom fields with parent model data. These examples illustrate how to use dot notation and basic script operations for dynamic calculations.
Minor updates to training modules which now refer to "custom fields" and include both inventory & finding fields, reflecting the integrated approach in the documentation.

Test Suggestions

Review the updated documentation pages for both model inventory and model validation to ensure the formatting and callouts render correctly.
Verify that all image paths are valid and images load as expected on the respective pages.
Check that the updated instructions correctly reflect that the description field is now optional and that only type and name are required when adding a field.
Test the code samples provided in the callouts to ensure they are syntactically correct and logically consistent with the described behavior.
Ensure that all links (e.g., to additional resources, modal dialogs, and dashboard settings) navigate to the correct pages.

github-actions · 2025-10-10T16:08:07Z

Validate docs site

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

nrichers · 2025-10-10T17:16:54Z

Can the formula codes be re-formatted? They look like this right now:

We had this issue before, it's a clash of Tachyons and Quarto styles. Will address via sc-12709.

FYI, the fix for the codeblock isssue is in #995

* Removing validmind version variable (#921) * infra: Merge main into staging PRs created by staging deploy now indicate original PR# (#924) * Updating main into staging workflow * Testing branch versions * Removing test file * Fix Makefile help * infra: Delete older PR preview comments from validate & execute flows (#932) * Adding deletion of old preview comments back in * Removing unused variable * Adding same thing to notebooks * Edit to notebook, should remove old comment * hm * Deleting test execution notebook * ValidMind Platform releases: Exclude `admin-ui` from roundup listing page (#933) * Exclude admin-ui from platform releases roundup * Adjust * Remove old variable usage --------- Co-authored-by: Nik Richers <nik@validmind.ai> * docs: Export findings (#939) * Setup: Customize model findings layout * Save point * Save point * Draft: Customize model finding layouts * Setup: Export findings * Draft: Export findings * Export documentation > Export documents * Editing * Cleanup * Proofread * Filter * Update API reference to use prod server (#938) * Update API reference to use prod server * Update Makefile for admin API as well * docs: Export inventory (#943) * Setup: Export inventory * Draft: Export inventory * Proofreading * Oops * docs: Updated Export findings (#944) * Setup * Proofread * Testing pinned Quarto version * docs: Customize Virtual Document Validator (#947) * Set up: Manage regulations and policies * WIP * Customize VDV draft * Edits: Check documentation for compliance * Proofread * Quick UI updates * Pin a Quarto version specified in Action variables for our deployment workflows (#951) * Testing pinned Quarto version * Applying pinned Quarto version to other workflows * Removing test notebook * docs: Workflow Wait step time delta configuration (#954) * Setup: Wait step time delta * Editing * Updating example screencap for Wait * Remove login button and make related CSS modular (#949) * Remove login button and make related CSS modular * Make login link specific to profile * Change scss/ to assets/style/ and update README.md * Fix double space * Check out .gitignore from main * Minor README.md tweak * One more minor README.md tweak * Add missing backticks * Fix Log In button for developer.css * Minor edits * Slight adjust to CSS in-progress message --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> * docs: Updated "Manage model finding fields" (#958) * Edit: DElete model findings * Edit: Manage model finding fields * Editing UI wording * Editing... * Editing...... * Proofreading * Edit * docs: Updated "Manage document templates" (#960) * Draft: Delete document templates * Edit: View document templates * Wrapping up * Stupid broken link * Edit: VDV Findings > Observations (#962) * docs: Update inventory & finding field views (#964) * Edit: Manage model inventory fields * Save point * Edit: Manage model finding fields * Cleanup * Proofread * Adjustments * Final touch * Fix bug in Makefile (#935) * Bug bash: nrichers/sc 12201/disable algolia search on api reference pages (#968) * Disable Algolia search on Public API reference page * Fix stray comment indent * docs: Add shared text blocks to YAML templates (#970) * Setup: Add library blocks to YAML templates * Save point * Save point * Tidying up * docs & training: Virtual Document Validator, regulations & policies set up update (#973) * Draft: Questions from PDF uploads * Training: Setup for regulations & policies * Save point * Save point * Draft: Administrator Fundamentals update * Draft: Developer Fundamentals update * Proofreading * Hiding PDF upload for VDV (#975) * Add system access requirements (#977) * Add initial system access requirements topic * Text edits * More edits * Fix incomplete sentence * Basic version: Improve navigation for Python API and Public REST API (#966) * Apply the basic fixes we agreed on * Remove a:hover experiment * Update .gitignore * Underline specific links only * Address review comments from Beck * Final CSS tweak * Update release_notes_check.py (#981) * Enable release notes checks to post comment with instructions (#984) * Update release_notes_check.yaml * Update release_notes_check.py * Edit: Remove info for add finding via doc section (#978) * docs: Updated Workflows Approval Step info (#979) * Edit: Approval step & condition instructions * Update: Approval Step example * Add Tidy Layout callout * Bump versions to 25.10 & v2.9.5 + public release landing page improvements (#971) * Bump release versions * Add temporary branch ref * Fix Makefile help * Reorder all releases page, bump up length of descriptions shown * Turn older releases into collapsible section * Fix YAML * Fix YAML again * Add pagination style from release notes portal * Add button for all feature highlights & add whitespace * Wording tweak * Run make get-source * All releases page tweaks * Fix broken links * Change heading to Latest features for consistency * Address Beck's sidebar suggestion * Fix date in this repo, too * Add whitespace before heading * Remove the branch ref I had THREE reminders for to remove ... (#991) * docs & training: Calculation Finding Fields (#988) * Draft: Calculation Finding Fields * Draft: Calculation Finding Fields in training * Save point * Cleaning up * Proofreading * Save point * Update site/guide/model-inventory/_field-types.qmd Co-authored-by: Nik Richers <nik@validmind.ai> * Update _field-types.qmd * Applying Andres's code edit --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Upgrade Tachyons with official codeblock fix & remove our workaround (#995) * Commit regenerated Python API files and bump version (#997) * docs: Workflows for findings (#998) * Setup: Workflows for findings * Renaming Setting up model workflows page * Fixing links * Sidebar link * Renaming directory * Fixing broken links pt2 * Cleaning up... * More cleanup * More * More renaming * Oops * Almost there * Stragglers * One more? * & includes * Save point * Edit: Add new workflows in docs * Edit: Edit existing workflows in docs * Edit: Review active workflows in docs * Edit: Review workflow histories in docs * Save point * Edit: Initiate workflows in docs * Edit: Abort workflows in docs * Edit: Manage workflow tasks * Edit: Transition workflows * More cleaup * Training: Edit Add new workflows * Training: Review active workflows * Training: Review workflow history * Training: Initiate workflows * Training: Reset workflows * Training: Abort workflows * Training: Transition workflows * Proofreading * More proofreading * ooo figured out a neat conditional hack * Editing training slides * Updating single-source templates * docs & training: Updates to model registration UX (#1003) * Edit: Register models in inventory * Quickstart: Register model developer * Quickstart: Register model validator * Updating code snippet images * Updating developer model details image * Updating validation report details image * Admin training: Register demo model * Developer training: Register demo model * Validator training: Register demo model * Cleanup * Proofreading * Edit: Manage model stakeholder types on registration * Edit: Manage model stakeholder types on registration training pt1 * Edit: Manage model stakeholder types on registration training pt2 * Edit * Edit * Pulling in latest notebooks from sibling PR * Nrichers/sc 12743/fix quarto docs workflow issue (#1001) * Remove validmind/ folder and old python-docs.zip file * Change make python-docs to generate the Python API files * Add site/validmind to the .gitignore * Add make python-docs equivalent to workflows * Try RELEASE_NOTES_RO_PAT * docs: Workflows User Action v2 step deadlines (#1005) * Setup: Edits to User Action v2 deadlines * Save point * Save point * Updated example images * Proofread * Formatting * Explicitly install poetry before generating Python API docs --------- Co-authored-by: Nik Richers <nik@validmind.ai> * Setup: Trigger workflow start on date & datetime (#1008) * Remove Slack sign-up page & update community resources (#1010) * Remove Slack sign-up page & update community resources * Minor consistency edit * Remove sign-up hint I added * docs: Manage finding severities (#1013) * Setup: Manage finding severities * Docs: Manage finding severities * Training: Manage finding severities * Cleaning up community page --------- 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>

validbeck added 6 commits October 9, 2025 11:58

Draft: Calculation Finding Fields

c9e3269

Draft: Calculation Finding Fields in training

cccc69a

Save point

1c2c900

Cleaning up

a5355b0

Proofreading

41326ff

Save point

812b08f

validbeck self-assigned this Oct 9, 2025

validbeck added the internal Not to be externalized in the release notes label Oct 9, 2025

validbeck requested review from cachafla and nrichers October 9, 2025 20:04

nrichers approved these changes Oct 9, 2025

View reviewed changes

site/guide/model-inventory/_field-types.qmd Outdated Show resolved Hide resolved

Update site/guide/model-inventory/_field-types.qmd

a9b701b

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

Update _field-types.qmd

2ec042f

cachafla reviewed Oct 10, 2025

View reviewed changes

Applying Andres's code edit

6a388de

Merge remote into local

b226069

validbeck merged commit 696e0a7 into main Oct 10, 2025
5 of 6 checks passed

validbeck deleted the beck/sc-12675/documentation-calculation-findings-fields branch October 10, 2025 16:16

docs & training: Calculation Finding Fields #988

docs & training: Calculation Finding Fields #988

Uh oh!

Conversation

validbeck commented Oct 9, 2025 • 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 Oct 9, 2025

Vale source linter

site/404.qmd

site/about/contributing/style-guide/conventions.qmd

site/about/contributing/style-guide/style-guide.qmd

site/about/contributing/style-guide/voice-and-tone.qmd

site/about/contributing/validmind-community.qmd

site/about/deployment/_deployment-available-options.qmd

site/about/deployment/deployment-options.qmd

site/about/deployment/multi-tenant-cloud.qmd

site/about/deployment/system-access-requirements.qmd

site/about/deployment/virtual-private-validmind.qmd

site/about/fine-print/data-privacy-policy.qmd

site/about/fine-print/license-agreement.qmd

site/about/glossary/_ai.qmd

site/about/glossary/_attestation.qmd

site/about/glossary/_developer-tools.qmd

site/about/glossary/_model-documentation.qmd

site/about/glossary/_models.qmd

site/about/glossary/_monitoring.qmd

site/about/glossary/_mrm.qmd

site/about/glossary/_validation-reports.qmd

site/about/glossary/_validmind-features.qmd

site/about/glossary/_validmind.qmd

site/about/glossary/glossary.qmd

site/about/glossary/key_concepts/_docs.qmd

site/about/glossary/key_concepts/_inputs.qmd

site/about/glossary/key_concepts/_key-concepts.qmd

site/about/glossary/key_concepts/_metrics.qmd

site/about/glossary/key_concepts/_monitoring-template.qmd

site/about/glossary/key_concepts/_outputs.qmd

site/about/glossary/key_concepts/_parameters.qmd

Uh oh!

nrichers left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

validbeck commented Oct 9, 2025

Uh oh!

github-actions bot commented Oct 9, 2025

Lighthouse check results

Uh oh!

cachafla commented Oct 10, 2025

Uh oh!

cachafla commented Oct 10, 2025

Uh oh!

cachafla left a comment

Choose a reason for hiding this comment

Uh oh!

validbeck commented Oct 10, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

nrichers commented Oct 10, 2025

Uh oh!

github-actions bot commented Oct 10, 2025

PR Summary

Test Suggestions

Uh oh!

github-actions bot commented Oct 10, 2025

Validate docs site

Uh oh!

Uh oh!

nrichers commented Oct 10, 2025

Uh oh!

Reviewers

Assignees

validbeck commented Oct 9, 2025 •

edited

Loading

validbeck commented Oct 10, 2025 •

edited

Loading