docs: Models > records phase II#1312
Merged
validbeck merged 78 commits intoMay 7, 2026
Merged
Conversation
Contributor
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 7d6d578 Modify the workflow to check a different depth:
|
validbeck
force-pushed
the
beck/sc-15849/documentation-primary-record-types-phase
branch
from
30ab489 to
4a8bbcf
Compare
Co-authored-by: Cursor <cursoragent@cursor.com>
validbeck
force-pushed
the
beck/sc-15849/documentation-primary-record-types-phase
branch
from
2abcbf8 to
536b2e6
Compare
Contributor
PR SummaryThis pull request performs a large-scale update to the project’s documentation files. The changes include:
These changes are purely editorial and semantic; they do not affect functional code but improve clarity and consistency in the documentation and help tools across the ValidMind platform. Test Suggestions
|
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
validbeck
deleted the
beck/sc-15849/documentation-primary-record-types-phase
branch
nrichers
pushed a commit
that referenced
this pull request
May 15, 2026
* WIP * model-documentation > documentation * model-validation > validation * Removing wrong aliases from inventory/ * Aliases for renamed directories * Renaming some files in documentation/ * Reverting notebooks to main, forgor to tell Cursor to ignore * Renaming some files in validation/ * Edit: Working with documentation * Edit: View development guidelines * Save point * Edit: Work with content blocks * WIP * Edit: Work with content blocks * Edit: Work with document versions * Edit: Assign development section statuses * Edit: Check documents for compliance * Edit: Collaborate with others * Submit for approval > Submit documents * Edit: Submit documents * Save point * Updating content of relevant glossary entries * Editing site/documentation/ related training slides * Manage model stages > Manage record stages * save point * Edit: Manage record stages * Edit: Introduction to workflows * Edit: Workflow step types * Edit: Conditional requirements * Renaming: Conditional requirements > Conditional step requirements * Edit: Workflot states & correcting .gitignore * Edit: Setting up workflows * Edit: Configure workflows * WIP: Workflow configuration examples * Edit: Manage workflows * Save point * Save point * Edit: Transition workflows * Edit: Manage workflow tasks * Proofreading workflows/ * Edit: Workflows in training * Renaming some files in validation/ * Edit: Managing validation * Edit: Manage validation guidelines * Edit: Manage artifact types * Edit: Manage artifact severities * Edit: Manage artifact fields * Save point * Edit: Preparing validation reports * Save point * Save point * Edit: Assess compliance * Save point * Save point * Edit: View & filter artifacts * Edit: Customize artifact layouts * Edit: Add & manage artifacts * Edit: Customize artifact overview page * Save point * Save point * Renaming some files in templates/ * Edit: Working with documents * Save point * Edit: Manage document types * Edit: Manage documents * Save point * Edit: Manage text block library * Proofreading templates/ * Edit: access/ * Edit: Managing your organization * Edit: Managing users * Edit: Personalizing ValidMind * Edit: Manage platform notifications * proofread * Map & assess accuracy edits Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com>
nrichers
added a commit
that referenced
this pull request
May 23, 2026
…ons (#1286) * Initial layout changes * Initial fixes for alignment, font * Hide sidebar nav toggle * Remove commented out YAML * Remove extra comments * Start moving to test-sandbox.qmd as the main entrypoint for test descriptions, delete old test-descriptions.qmd and tests/ folder * Remove test-descriptions from Makefile, clean up links and listings, fix old release notes * Fix borked links * Fix more borked links * Fix link, again * docs: Document Checker expansion & Guides update (#1284) * sidebar shuffle * Renaming document checker guide * wip edit: Customize document checker * Save point * Save point * Unhiding generate assessment from PDF * Rename: Check documents for compliance * Edit * Edit: Check documents for compliance * Adding check documents for compliance to validation * Admin training edit * Screenshot rename or update * Validation training — + Document Checker * Proofreading * Fixing the cookie issue for the external previews * Edit * Shuffling wip * guides landing reshuffle * Save point * Testing... * More testing * more * Save point * Save point * Edit * Edit * Tweak * Editing extension README * Edit * Edit * Forgot the footer links, standarizing breadcrumb casing * Kam's suggestions * Oops, accidentally committed Cursor plans * docs: Enabling org-wide track changes disables AI-content drafts (#1288) * Edited: Managing your organization * Edited: Work with content blocks * Edit 1 * Edit 2 * Edit: Manage text block library * Proofread * docs: Export document checker results (#1290) * Edit: Check documents for compliance * proofread * documentation: Save drafts for workflow user action submissions (#1291) * Edit: Transitition workflows * Proofreading * Update as per JAM's comments * docs: Workflow draft state (#1293) * Setup for workflow drafts * WIP: Publishing workflows * Save point * Training WIP * Edited: Using ValidMind for Model Risk Management * Edited: Setting up workflows * Updated: Filtering workflows * Edits as per Luis's suggestion * docs: Models > records docs update phase 1 (#1287) * model-inventory directory > inventory * Renaming files in inventory/ * Patching footer, oops Made-with: Cursor * Renaming more files in inventory/ * inventory/_embeds edit * Model Inventory > Inventory; Model Activity > Activity; anchor link * Edit: inventory/ pt1 Made-with: Cursor * Setup for Manage inventory record types * Edit: inventory/pt2 Made-with: Cursor * Rename: Manage model stakeholder types > Manage record stakeholder types * Editing: Manage record stakeholder types * Save point * Save point * Edited: Manage record stakeholder types * Cleanup... * Edit: Work with filters * Proofreading * Proofread: Old inventory/ guides * Proofread: Administrator Fundamentals training * WIP * WIP: Manage inventory record types > Add record types * Manage inventory record types draft * Save point * Editing Administrator Fundamentals training * Admin training WIP edit * +Record types to admin training * Copyright headers * Changing installation ref branch, remove after * missed some anchor links * one more * Update .github/workflows/validate-docs-site.yaml * Fixing borked links * oops, missed one * docs: Add public "Using the documentation" hub page (#1300) * docs: Add public "Using the documentation" hub page Add a site map and section intent page to help users navigate the documentation and to provide structured content for RAG retrieval. The page covers all major documentation sections with intent descriptions and typical tasks. Closes sc-15631 * Move using-the-documentation to Contributing section - Move file from about/ to about/contributing/ - Update _quarto.yml navigation to place under Contributing * Add links to section headers and update table links - Make section headers link to their landing pages - Update Guides table to link to guides.qmd anchors instead of individual pages - Fix table formatting (remove double pipes) * Fix anchor links to match actual guides.html structure - #inventory → #model-inventory (matches actual section name) - #integrations → direct link to managing-integrations.qmd (no section on guides page) - #documents-templates → direct link to working-with-model-documents.qmd (no section) - Rename "Inventory" to "Model inventory" for consistency * Revert label to 'Inventory' (current terminology) * Add validmind-chatbot.png to In-product help section * Add AGENTS.md to guide AI agents to documentation hub Points agents to the "Using the documentation" page as the starting point for understanding the docs structure and navigation. * Add chatbot capabilities reference to AGENTS.md * docs: Address review feedback for documentation hub page - Fix broken anchor #model-inventory → #inventory in guides table - Add chatbot screenshot for in-product help section - Convert AGENTS.md links to absolute HTTPS URLs - Move using-the-documentation.qmd to end of About sidebar * docs: Add unlisted chatbot capabilities page (Phase 1-2) (#1298) * docs: Add unlisted chatbot capabilities page (Phase 1-3) Adds an unlisted documentation page describing what the in-app assistant can and cannot do across product phases. Includes clear boundaries, limitations, and distinction from MCP integration. Resolves sc-15632 * fix: Update chatbot capabilities to reflect Phase 2 as current - Remove phase-based structure since Phase 2 is now the current state - Document context-aware capabilities as current (understands location, permission-aware) - Keep action execution as a future capability (Phase 3) - Simplify structure to Current / Future / Limitations - Update comparison table to reflect context awareness * Remove Future capabilities section * Use 'refer to' instead of 'see' * docs: Add live query scope limitation to chatbot capabilities Clarifies that live queries currently support model inventory and artifacts only — workflows, analytics, and other areas are not yet available. * fix: Use search: false instead of listing: false * docs: Add autogenerate validation issues documentation (#1304) * docs: Add autogenerate validation issues documentation Document the AI-powered feature that suggests validation issues based on risk assessment notes during compliance assessment. Validators can review, approve, or dismiss AI-generated suggestions. [sc-15712] * Simplify navigation: click Validation link directly * docs: Add public "Using the documentation" hub page (#1300) * docs: Add public "Using the documentation" hub page Add a site map and section intent page to help users navigate the documentation and to provide structured content for RAG retrieval. The page covers all major documentation sections with intent descriptions and typical tasks. Closes sc-15631 * Move using-the-documentation to Contributing section - Move file from about/ to about/contributing/ - Update _quarto.yml navigation to place under Contributing * Add links to section headers and update table links - Make section headers link to their landing pages - Update Guides table to link to guides.qmd anchors instead of individual pages - Fix table formatting (remove double pipes) * Fix anchor links to match actual guides.html structure - #inventory → #model-inventory (matches actual section name) - #integrations → direct link to managing-integrations.qmd (no section on guides page) - #documents-templates → direct link to working-with-model-documents.qmd (no section) - Rename "Inventory" to "Model inventory" for consistency * Revert label to 'Inventory' (current terminology) * Add validmind-chatbot.png to In-product help section * Add AGENTS.md to guide AI agents to documentation hub Points agents to the "Using the documentation" page as the starting point for understanding the docs structure and navigation. * Add chatbot capabilities reference to AGENTS.md * docs: Address review feedback for documentation hub page - Fix broken anchor #model-inventory → #inventory in guides table - Add chatbot screenshot for in-product help section - Convert AGENTS.md links to absolute HTTPS URLs - Move using-the-documentation.qmd to end of About sidebar * docs: Add Bedrock evaluation metrics integration documentation (#1303) * docs: Add Bedrock evaluation metrics integration documentation Document the new integration metrics feature for monitoring documents: - Add "From Integration" tab flow for adding Bedrock Agent Evals - Add global time selector section for monitoring documents - Document connection detail page with metric sources - Add metric sources management section for Bedrock connections * Add health monitoring section from #1297 to simplify merging * Add 'feature' and simplify monitoring navigation * Update global time range section with correct terminology - Rename "time selector" to "time range" to match UI - Add clock icon reference - List available options (All Time, relative presets, Custom range) - Note that setting is only visible to the current user * Fix integration metric configuration options - Add both threshold (lower) and threshold (upper) fields - Rename "time window" to "time range" to match UI - Expand time range description with available options * Use commas instead of em-dashes for parenthetical phrases * docs: Address review feedback for Bedrock integration docs - Update step 7 to describe Evaluators list instead of Bedrock Agent Evals - Rename Metric Sources references to Monitoring to match UI tab name * docs: Document Model Activity in Analytics Data Export (#1302) * docs: Add Model Activity to analytics data export datasets Add Model Activity as an available dataset option in Analytics Data Export configuration. Model Activity exports audit events (comments, workflow status changes, field updates) for compliance reporting and audit trails. Shortcut: sc-15291 * Add custom artifact types and inventory record types to export list * Change colon to 'For example:' * docs: Clarify Model Activity date filtering options Change "date range filtering" to "30, 60, or 90-day window filtering" to accurately reflect the fixed window picker in the UI. * docs: add visibility into integrations health (#1297) * docs: add visibility into integrations health Add documentation for the new Connections dashboard that provides visibility into integration health, including status indicators, linked models, metric sources, and troubleshooting guidance. [sc-15885] * Fix: connections with issues show status indicator, not sorted to top * Add example status indicator for sync errors * Fix connection status labels and colors to match frontend * Clarify Linked Models shows both VM records and external models * Fix: describe linked models table with correct column names * Use vm.product variable instead of hardcoded ValidMind * docs: Remove inaccurate Recent activity bullet The connection details page has Links and Monitoring tabs, not a recent activity/sync history section. Sync errors appear as badges on the row, not in a feed. * Preview for 26.05 release notes + `make get-source` (#1305) * Add temporary release-notes branch ref for 26.05 preview Points to nrichers/sc-15927/release-notes-for-26-05 branch in release-notes repo. * Run make get-source * Give tables on all-releases page more room * Move 2025 releases into their own section * Experiment with excluding releases/ from search * Remove branch ref * docs: Map and assess evidence (#1299) * docs: Add autogenerate validation reports documentation Document the AI-powered features for validators: - Auto-Link Evidence for single/bulk guideline evidence linking - Risk Assessment Generation for single/bulk assessments - Understanding the structured AI-generated assessment format Closes sc-14812. * fix: Rename to map-and-assess-evidence with accurate UI terminology - Rename file from autogenerate-validation-reports.qmd to map-and-assess-evidence.qmd - Update title to "Map and assess evidence" - Fix UI element names to match actual product (Map Evidence, Assess Evidence) - Describe Evidence Assessment output structure accurately - Add relevance threshold slider documentation * Add screenshots for Map Evidence and Assess Evidence panels - Add map-evidence-panel.png showing evidence type toggles and relevance threshold - Add assess-evidence-panel.png showing compliance assessment option - Display both in column-margin divs alongside their respective sections * fix: Add Approve All / Reject All workflow for Map and Assess Evidence - Update Map Evidence steps to describe approve/reject workflow - Update Assess Evidence steps to describe approve/reject workflow - Clarify that editing is available after approving assessments * Add individual approve/reject, relevance analysis, and reassess options - Add individual Approve/Reject buttons for mapped evidence - Add See Relevance Analysis option with relevance score explanation - Add individual Approve/Reject buttons for evidence assessments - Add Reassess Evidence option to regenerate assessments - Add new "Understand mapped evidence" section explaining relevance scores and analysis * Distinguish report-level vs section-level approve/reject workflows - Report overview: Approve All / Reject All for entire report - Section-level: Individual Approve / Reject per evidence item or assessment - Clarify the two-level review structure for both Map Evidence and Assess Evidence * Consolidate intro into benefits-focused overview section Replace detailed "Understand mapped evidence" and "Understand evidence assessments" sections with a concise "How do evidence mapping and assessment work?" section that explains the benefits for new users. * Format overview section as definition list * Remove What's next section * Remove unused evidence-assessment-example.png * Add What's next section with listing to assess-compliance Links to the manual compliance assessment workflow for users who prefer traditional evidence linking and assessment selection. * Document Remap Evidence button in report overview * Replace 'report overview' with visible UI terminology Changed 'From the report overview' to 'For the entire report' and removed references to non-existent 'Overview page' label. * Simplify navigation: click Validation link directly * Address review comments from Fernanda * Fix link warning * docs: Add Databricks integration documentation (#1301) * docs: Add Databricks Unity Catalog integration documentation Add documentation for the new Databricks integration that enables linking ValidMind inventory records to Databricks Unity Catalog resources including models, datasets, and agents. - Add Databricks to supported connections in configure-connections.qmd - Add Databricks to model inventory integrations in managing-integrations.qmd - Add step-by-step connection and linking examples in integrations-examples.qmd Closes sc-14813 * Add placeholder columns to integrations grid layout * Fix Databricks connection field names to match UI - databricks host → workspace url - client id → sql warehouse id - client secret → personal access token * Fix Databricks link model steps to match UI * docs: Fix Databricks connection field descriptions - client id: Update to describe SQL Warehouse ID - client secret: Update to describe PAT token secret * docs: Add developer workflow for running validations on Databricks data Add a new section explaining how to run validation notebooks against Databricks-hosted data, with a link to the quickstart notebook and a mermaid diagram showing the data flow between platforms. * Split examples up into separate files. * File rename * Remove terminology ambiguity * Edits * Add missing headings for steps * Add configuration screenshot * docs: Models > records phase II (#1312) * WIP * model-documentation > documentation * model-validation > validation * Removing wrong aliases from inventory/ * Aliases for renamed directories * Renaming some files in documentation/ * Reverting notebooks to main, forgor to tell Cursor to ignore * Renaming some files in validation/ * Edit: Working with documentation * Edit: View development guidelines * Save point * Edit: Work with content blocks * WIP * Edit: Work with content blocks * Edit: Work with document versions * Edit: Assign development section statuses * Edit: Check documents for compliance * Edit: Collaborate with others * Submit for approval > Submit documents * Edit: Submit documents * Save point * Updating content of relevant glossary entries * Editing site/documentation/ related training slides * Manage model stages > Manage record stages * save point * Edit: Manage record stages * Edit: Introduction to workflows * Edit: Workflow step types * Edit: Conditional requirements * Renaming: Conditional requirements > Conditional step requirements * Edit: Workflot states & correcting .gitignore * Edit: Setting up workflows * Edit: Configure workflows * WIP: Workflow configuration examples * Edit: Manage workflows * Save point * Save point * Edit: Transition workflows * Edit: Manage workflow tasks * Proofreading workflows/ * Edit: Workflows in training * Renaming some files in validation/ * Edit: Managing validation * Edit: Manage validation guidelines * Edit: Manage artifact types * Edit: Manage artifact severities * Edit: Manage artifact fields * Save point * Edit: Preparing validation reports * Save point * Save point * Edit: Assess compliance * Save point * Save point * Edit: View & filter artifacts * Edit: Customize artifact layouts * Edit: Add & manage artifacts * Edit: Customize artifact overview page * Save point * Save point * Renaming some files in templates/ * Edit: Working with documents * Save point * Edit: Manage document types * Edit: Manage documents * Save point * Edit: Manage text block library * Proofreading templates/ * Edit: access/ * Edit: Managing your organization * Edit: Managing users * Edit: Personalizing ValidMind * Edit: Manage platform notifications * proofread * Map & assess accuracy edits Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: Cursor <cursoragent@cursor.com> * Databricks docs updates (#1320) * Refresh notebooks * Fix short description overrun * Update notebook link * Revert to 2-column layout * docs: Calculated fields formula reference (#1323) * docs: Calculated fields formula reference (sc-15979) Rewrites the Calculation field type docs in a Starlark-first voice and adds a built-in helper-functions table. Updates the worked Risk Tier, Next Review Date, and Days Remaining examples to dict-access params and the new helpers; each example was verified through the canonical transpile() and StarlarkExecutor.run() pipeline from validmind/backend@origin/main. Adds a single note callout in the Calculation entry that names the engine and confirms stored formulas were migrated automatically. Removes the three calculated-field screenshots pending the locked editor UI. * Edits * Put some docstrings back * Edits * Edits * Fix render warnings * Remove troublemaker anchor * Copy AGENTS.md into the root of the GFM output folder (#1326) * Add uv setup step * Fix broken link * Switch to uv@v5 * Fix test-descriptions alias * Reapply removal of old test-description references --------- Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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?
Continuing the work for primary record types (models > records etc.). This PR covers more updates in the Guides section of the documentation and one of the quickstarts.
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
Guides
Access
Configuration
Workflows
Documents & templates
Model documentation > Documentation
Model validation > Validation
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):
Dependencies, breaking changes, and deployment notes
More proposed changes for the platform UI where the wording was not updated from model where it should have been, or labels/help text were unnecessarily wordy/confusing etc.: https://github.com/validmind/frontend/pull/2490
Release notes
n/a
Checklist