Skip to content

Merge staging into prod#1314

Merged
nrichers merged 72 commits intoprodfrom
staging
May 2, 2026
Merged

Merge staging into prod#1314
nrichers merged 72 commits intoprodfrom
staging

Conversation

@nrichers
Copy link
Copy Markdown
Collaborator

@nrichers nrichers commented May 2, 2026

Pull Request Description

What and why?

This PR releases our latest 26.05 docs to prod.

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

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 and others added 30 commits April 7, 2026 12:24
* Managing your organization + Manage business units

* Set up your organization

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Save point

* Update: Manage platform notifications > Customize email notifications

* Cleanup: Integrations examples

* Edit: Manage groups

* proofread

* proofread x2

* proofread x3

* Edit

* Edit: Manage roles

* proofread

* proofread x2

* Edited: Manage model stakeholder types

* Proofread: Admin quickstart + related includes

* Proofread: Manage users

* Proofread: Manage roles

* Proofread: Manage model stakeholder types

* Proofread: Manage permissions

* Proofread: Workflow states

* Proofread: Manage model stages

* Proofread: Configure workflows

* Proofread: Manage model inventory fields

* Proofread: Manage document types

* Proofread: Manage artifact types

* Save point

* Proofread: Manage artifact severities

* Proofread: Manage artifact fields

* UI adjustments

Made-with: Cursor

* Edit

* Edit 2

* Fixing some weird footnotes

* Edit

* Edit

* Not sure why settings file was included
* WIP

* Edit: Manage workflows > Update active workflows
- New page covering proxy env vars and troubleshooting
- Link from ValidMind Library sidebar
* Edit

* wip

* Edit: Workflow step types

* Edit: Confitional requirements

* Glossary fix

* Fixing About library & platform page

* Fixing a broken breadcrumb

* Edit: Configure workflows

* proofread

* Setting up workflows: +View, sort, and filter workflows

* Proofread

* Edit: John's suggestions
HTTP proxy guide for ValidMind Library
…r-attestation-periods

Add FAQ for attestation visibility before period starts & clarify callout
…-appendix-toggle-frontend-pr-2419

Document tables and figures appendix export option
* Initial draft with edits

* Edits after testing

* Fix render warnings
validbeck and others added 25 commits April 27, 2026 14:41
* 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

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

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

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

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

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.
* 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
@nrichers nrichers added the internal Not to be externalized in the release notes label May 2, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

PR Summary

This pull request introduces comprehensive documentation updates across the project. The main changes include:

  • Renaming terminology from "model inventory" to "inventory" (with many references updated to "records", "record activity", "register records" etc.) in documentation files, guides, training modules, and release notes. This ensures a more consistent and modern naming convention.

  • Updating sidebar links, references, widgets, and instructions to point to new paths, for example replacing references to /guide/model-inventory/… with /guide/inventory/… and similarly updating text such as "View model activity" to "View record activity".

  • Adjustments to several training materials and workflow guides, including changes in the configuration pages (e.g. from Workspace to specific sections such as under a "shield" or "cube" icon) and a number of improvements in CSS styling for improved footer layout and sidebar appearance.

  • Minor textual clarifications in several notebook examples (e.g. AI text generation, testing, and risk evaluation) and in code snippets for Python, as well as dependency adjustments for package version compatibility.

Overall, the changes are primarily non-functional, focusing on documentation improvements to enhance clarity, consistency, and user navigation, along with a major shift in naming conventions across the project.

Test Suggestions

  • Manually click on updated sidebar links (e.g., inventory, view record activity, register records) to ensure they redirect correctly to their intended pages.
  • Run a full documentation build (e.g., using Quarto) to verify that all markdown files compile without errors and all reference links resolve correctly.
  • Review the modified CSS changes in the footer and sidebar to confirm that layouts render correctly across different browsers and screen sizes.
  • Perform a search across the site (using the updated filters and links) to ensure that the term changes from 'model' to 'record' are consistent and correctly displayed.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

Validate docs site

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

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 2, 2026

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: 6aa0b59

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.73 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.68 1.00 0.73
/support/support.html 0.91 0.70 1.00 0.82
/training/training.html 0.85 0.62 0.96 0.73

@nrichers nrichers merged commit 1e05f2d into prod May 2, 2026
9 checks passed
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.

2 participants