Skip to content

docs: Updated glossary (key concepts) & FAQ#1339

Merged
validbeck merged 52 commits into
mainfrom
beck/sc-15992/documentation-primary-record-types-glossary
May 26, 2026
Merged

docs: Updated glossary (key concepts) & FAQ#1339
validbeck merged 52 commits into
mainfrom
beck/sc-15992/documentation-primary-record-types-glossary

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented May 21, 2026

Pull Request Description

What and why?

sc-15992

More primary record type updates, this time for the About (glossary mainly) and Support (FAQ mostly) sections of the site.

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 verify everything looks OK:

About

OLD NEW
About ValidMind About ValidMind
Using the documentation Using the documentation

Product features

OLD NEW
ValidMind Library and ValidMind Platform ValidMind Library and ValidMind Platform
Automated testing & documentation Automated testing & documentation
Large language model features Large language model features
Deployment options Deployment options
System access requirements System access requirements
Glossary Glossary — This is the most major update

Contributing

OLD NEW
ValidMind community ValidMind community
Conventions Conventions
Voice and tone Voice and tone

Fine print

OLD NEW
Data privacy policy Data privacy policy

Guides

OLD NEW
Working with documentation Working with documentation

Support

OLD NEW
Support Support
Troubleshooting Troubleshooting

FAQ

OLD NEW
FAQ FAQ
Access and permissions Access and permissions
Workflows Workflows
Inventory and activity Inventory and activity
Documents and templates Documents and templates
Validation and artifacts Validation and artifacts
Collaboration Collaboration
Ongoing monitoring and reporting Ongoing monitoring and reporting
Testing Testing
Integrations and support Integrations and support
Data handling and privacy Data handling and privacy

What needs special review?

Still one more update that needs to be made to the docs as this new functionality is pretty all-encompassing.

What's not covered and will be in a future Story (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

Dependencies, breaking changes, and deployment notes

Notebooks pulled in from validmind/validmind-library#517.

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 mentioned this pull request May 22, 2026
8 tasks
@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: 84b884e

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.58 1.00 0.82
/get-started/get-started.html 0.85 0.72 1.00 0.73
/guide/guides.html 0.85 0.70 1.00 0.82
/index.html 0.93 0.62 1.00 0.82
/releases/all-releases.html 0.86 0.69 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

Copy link
Copy Markdown

@even-steven even-steven left a comment

Choose a reason for hiding this comment

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

👍🏽

@validbeck
Copy link
Copy Markdown
Collaborator Author

validbeck commented May 26, 2026

Comments from Steven to address:

  • done

1. Broken footnote in _ai-governance.qmd (line 18)
The bias, algorithmic bias definition ends with a bare .^ — incomplete footnote that will render as a literal ^ or cause a build warning. Either complete it with ^[**Refer to:** ...] or remove the caret.

  • done

2. Code block errors in overview-documentation.qmd (lines 83–94)
The new file has invalid Python examples — extra spaces after dots and a capitalized method name:
vm. log_dataset(vm.log_dataset(
vm. run_dataset_tests(vm.run_dataset_tests(
vm. Log_model (model)vm.log_model(model) (capital L + extra spaces)
vm. log_training_metrics (model, ...)vm.log_training_metrics(model, ...)
vm. run_model_tests (model, ...)vm.run_model_tests(model, ...)

  • done

3. Missing article in key_concepts/_models.qmd (lines 9 & 16)
"a model is type of record" → "a model is a type of record" (appears in both the glossary and non-glossary variants)

  • done

4. Awkward possessive pattern (style — multiple files)
record (model)'s and record (such as a model)'s appear throughout — putting 's on a parenthetical is non-standard. Affects _ongoing-monitoring.qmd, _model-performance.qmd, _backtesting.qmd, _monitoring-governance.qmd, overview-llm-features.qmd, and others. Suggest rephrasing to e.g. "the record's accuracy (such as a model's)" or just "the record's" with context provided elsewhere in the definition.

@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

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

@validbeck validbeck merged commit f5ed355 into main May 26, 2026
6 of 8 checks passed
@validbeck validbeck deleted the beck/sc-15992/documentation-primary-record-types-glossary branch May 26, 2026 21:09
@github-actions
Copy link
Copy Markdown
Contributor

Execute training notebooks for PRs

✓ INFO: Live previews are available —

@validbeck validbeck mentioned this pull request May 26, 2026
11 tasks
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.

3 participants