You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
internalNot to be externalized in the release notes
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
What and why?
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
Product features
Contributing
Fine print
Guides
Support
FAQ
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):
Dependencies, breaking changes, and deployment notes
Notebooks pulled in from validmind/validmind-library#517.
Release notes
n/a
Checklist