docs: Models > records phase II

[validbeck]

Pull Request Description

What and why?

sc-15849

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

OLD	NEW
Quickstart — Setup & Administration	Quickstart — Setup & Administration

Guides

Access

OLD	NEW
Accessing ValidMind	Accessing ValidMind
Register with ValidMind	Register with ValidMind
Sign up via AWS Marketplace	Sign up via AWS Marketplace
Log in to ValidMind	Log in to ValidMind

Configuration

OLD	NEW
Managing your organization	Managing your organization
Set up your organization	Set up your organization
Configure AWS PrivateLink	Configure AWS PrivateLink
Configure Google Cloud Private Service Connect	Configure Google Cloud Private Service Connect
Configure Azure Private Link	Configure Azure Private Link
Managing users	Managing users
Manage groups	Manage groups
Manage roles	Manage roles
Manage permissions	Manage permissions
Personalizing ValidMind	Personalizing ValidMind
Manage your profile	Manage your profile
Customize your dashboard	Customize your dashboard
Manage platform notifications	Manage platform notifications

Workflows

OLD	NEW
Introduction to workflows	Introduction to workflows
Workflow step types	Workflow step types
Workflow states	Workflow states
Setting up workflows	Setting up workflows
Manage model stages	Manage record stages
Configure workflows	Configure workflows
Workflow configuration examples	Workflow configuration examples
Working with workflows	Working with workflows
Manage workflows	Manage workflows
Transition workflows	Transition workflows
Manage workflow tasks	Manage workflow tasks

Documents & templates

OLD	NEW
Working with model documents	Working with documents
Manage document types	Manage document types
Manage model documents	Manage documents
Working with templates	Working with templates
Customize document templates	Customize document templates
Manage document templates	Manage document templates
Manage text block library	Manage text block library
Customize ValidMind Document Checker	Customize ValidMind Document Checker

Model documentation > Documentation

OLD	NEW
Working with model documentation	Working with documentation
View documentation guidelines	View development guidelines
Work with content blocks	Work with content blocks
Work with test results	Work with test results
Work with document versions	Work with document versions
Assign documentation section statuses	Assign development section statuses
Check documents for compliance	Check documents for compliance
Collaborate with others	Collaborate with others
Submit for approval	Submit documents

Model validation > Validation

OLD	NEW
Managing model validation	Managing validation
Manage validation guidelines	Manage validation guidelines
Configure assessment options	Configure assessment options
Manage artifact types	Manage artifact types
Manage artifact severities	Manage artifact severities
Manage artifact fields	Manage artifact fields
Preparing validation reports	Preparing validation reports
Review model documentation	Review documentation
Assess compliance	Assess compliance
Working with artifacts	Working with artifacts
View and filter artifacts	View and filter artifacts
Customize artifact layouts	Customize artifact layouts
Add and manage artifacts	Add and manage artifacts
Customize artifact overview page	Customize artifact overview page

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):

• 15850: Updates to the validmind-library notebooks & templates, pulling those notebooks and templates into the documentation and demo-environment repos, updating the related get started and training sections that relate to the updated notebooks, updating related information in the "developer" portal
• 15995: Remaining updates to "Guides", update of "Administrator Fundamentals" training
• 15992: Updates to the "About" and "Support" sections of the docs site
• 15921: The "Workflow configuration examples" got a minor wording update but we need to simplify this page as the screenshots on here are way too much work to update each time we change the UI. Note that the screenshots will stay outdated until the work in this Story.

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

• 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]

lgtm!

[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: 7d6d578

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.68	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.68	1.00	0.82
/releases/all-releases.html	0.86	0.69	1.00	0.73
/support/support.html	0.91	0.69	1.00	0.82
/training/training.html	0.85	0.69	0.96	0.73

[github-actions]

PR Summary

This pull request performs a large-scale update to the project’s documentation files. The changes include:

• Renaming of terms related to "model" documentation and lifecycle (e.g. "model documentation", "model validation", "model stages") to be more generic or to refer to "records" and "inventory records". This makes the language consistent when describing records, artifacts, and workflows.
• Updates to file paths and URL aliases have been applied throughout, replacing paths such as /guide/model-documentation/ and /guide/model-validation/ with /guide/documentation/ and /guide/validation/, respectively.
• Similar changes are made for workflow-related documentation to rename references from model workflows and model stages to record workflows and record stages.
• Several internal links and references (e.g. for content blocks, test results, and collaboration documents) have also been updated to reflect these changes.

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

• Build the documentation site locally and navigate through all major sections (documentation, validation, workflows, inventory) to ensure that all links resolve correctly.
• Verify that the updated aliases and file paths correctly render on both the online website and in print/document exports.
• Perform a search within the documentation for legacy terms ('model documentation', 'model validation') to confirm that they have been replaced with the new terminology.
• Check navigation menus, sidebar links, and cross-references to ensure consistency following the renaming.

[github-actions]

Validate docs site

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