docs: Document Checker expansion & Guides update

[validbeck]

Pull Request Description

What and why?

sc-13486

You can now use the ValidMind Document Checker to check documents other than Development (Monitoring, Validation, custom document types). Docs and training updated to reflect this functionality:

_variables.yml

Changed the long form variable for the document checker to "ValidMind Document Checker" (from previous Virtual Document Validator) enabling this unified terminology display in the rest of the docs:

documentation/site/_variables.yml

Line 31 in 46058d3

checker: "ValidMind Document Checker"

Customize Virtual Document Validator > Customize Document Checker

• Renamed this file from customize-virtual-document-validator.qmd to customize-document-checker.qmd, patched any broken links, and included an alias for redirect from the old filepath
• Edit this page to include information on setting up assessments other than Development type assessments, cleaned up any outdated references to updated UI

Check documentation for compliance > Check documents for compliance

• Renamed this file from check-documentation-for-compliance.qmd to check-documents-for-compliance.qmd, patched any broken links, and included an alias for redirect from the old filepath
• Edit this page to include information on using the document check for document types other than Development, cleaned up any outdated references to updated UI

Training

Using ValidMind for Risk Management

Slides under "Manage regulations & policies" have been updated:

• ValidMind Document Checker
• Add regulations & policies
• Add a regulation or policy
• Add assessments
• Add an assessment
• Add assessment questions
• Add an assessment question

Finalizing Model Documentation

Slides under "Refine model documentation" have been updated:

• ValidMind Document Checker
• Use the Document Checker
• Check your model documentation

Finalizing Validation Reports

Added the following slides under "Refine validation report":

• ValidMind Document Checker
• Use the Document Checker
• Check your validation report

Guides landing / Navigation sidebar

OLD	NEW
	guides-new.mov

The Guides landing got a makeover because it was really cluttered and didn't align with the rest of the user experience. Now it displays parent topics in the same order as the sidebar, and makes use of the new sidebar-slim extension:

• README.md explaining how the extension works and is implemented, and where it is currently active
• site/guide/_metadata.yml that applies the extension and new sidebar styling to this directory only (for now)

The side navigation has also been cleaned up and grouped into sub-topics instead of a super long scrollbar. A new site/guide/guides.css applies styling to the sectional navigation headings in the new cleaned up sidebar.

Etc.

Personalize ValidMind > Personalizing ValidMind

I realised this page should have the gerund as it's a parent topic with children topic; renamed the file from personalize-validmind.qmd to personalizing-validmind.qmd, patched any broken links, and included an alias for redirect from the old filepath.

About / Large language model features

• Updated older wording around the document checker that only referred to model documentation.
• Fixed the issue where the preview for external links was causing the link out to our product site to only display the cookie consent banner (just simplified it to use CTA buttons); there was also a small issue in our stylesheet where button links for some reason were force-underlining under hover (not our intended behaviour) so I fixed that:

documentation/site/assets/styles/_links.scss

Line 16 in 46058d3

#whats-next a:hover:not(.quarto-grid-link):not(.button) {

OLD	NEW

FAQ / Integrations and support

Updated older wording around the document checker that only referred to model documentation.

How to test

Docs updates

Click on the live previews for the updated docs:

• About / Large language model features
• Guides:
  • Personalizing ValidMind
  • Customize ValidMind Document Checker
  • Check documents for compliance
• FAQ / Integrations and support
• Administrator Fundamentals / Using ValidMind for Risk Management (CLICK THRU THE NEXT SLIDES FOR):
  • ValidMind Document Checker
  • Add regulations & policies
  • Add a regulation or policy
  • Add assessments
  • Add an assessment
  • Add assessment questions
  • Add an assessment question
• Developer Fundamentals / Finalizing Model Documentation (CLICK THRU THE NEXT SLIDES FOR):
  • ValidMind Document Checker
  • Use the Document Checker
  • Check your model documentation
• Validator Fundamentals / Finalizing Validation Reports (CLICK THRU THE NEXT SLIDES FOR):
  • ValidMind Document Checker
  • Use the Document Checker
  • Check your model validation report

Sidebar extension

Note

The extension has already been enabled globally and turned on for the specific directory site/guides/. If you want, you can test it on other pages with the instructions in the README.

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

I updated some of the UI text to reflect the actual functionality: https://github.com/validmind/frontend/pull/2442

Release notes

Covered by https://github.com/validmind/frontend/pull/1855 in AI-powered regulatory and policy alignment: Document Checker for validation.

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)

[kam-validmind]

minor notes but looking good

[github-actions]

PR Summary

This pull request introduces a new "Sidebar slim" extension that allows users to collapse the site sidebar into a narrow vertical strip when the sidebar-slim: true metadata is set. The extension provides a desktop-only toggle wired up via a new JavaScript module that handles the toggle state (persisted in sessionStorage), applies CSS transitions to narrow the sidebar, and injects necessary configuration using a Lua filter. The accompanying CSS file applies media queries to ensure that the functionality only activates on screens wider than 992px, leaving default responsive behavior intact on smaller screens.

In addition, the PR makes several documentation and configuration updates. These include updates to the sidebar README and extension metadata, adjustments in navigation definitions, reordering of sections, and minor text changes across markdown and YAML files to reflect the new sidebar functionality and updated terminology. The changes help integrate the sidebar-slim feature into the larger documentation and training materials, ensuring a consistent user experience throughout the site.

Test Suggestions

• Manually verify that when sidebar-slim: true is set (via page, directory, or project metadata), the sidebar collapses appropriately on desktop screens (≥992px).
• Test that clicking the toggle button expands and collapses the sidebar and that the state persists across page reloads using sessionStorage.
• Resize the browser window to confirm the extension activates only on larger screens and gracefully disables on smaller devices.
• Inspect the generated HTML to ensure the Lua filter injects the configuration JSON correctly in the header.
• Review sidebar navigation on multiple pages to verify updated links and section structures render as intended.

[github-actions]

Validate docs site

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

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

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.69	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.67	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.62	0.96	0.73