docs: Map and assess evidence by nrichers · Pull Request #1299 · validmind/documentation

nrichers · 2026-04-30T01:51:52Z

What and why?

Documents the Map Evidence and Assess Evidence features (sc-14812). These AI-assisted tools help validators link relevant evidence to validation guidelines and generate structured compliance assessments.

Changes:

Added map-and-assess-evidence.qmd covering:
- Overview explaining benefits for new users
- Map Evidence feature (AI-guided evidence linking with relevance threshold)
- Assess Evidence feature (compliance assessment generation)
- Review workflow for entire report vs. individual guidelines
- Individual and bulk approve/reject options
- Remap Evidence and Reassess Evidence for regenerating suggestions
Added screenshots for Map Evidence and Assess Evidence panels
Added What's next section linking to manual workflow (assess-compliance.qmd)
Updated sidebar navigation

How to test

Try the live preview:

Map and assess evidence

What needs special review?

Verify Map Evidence UI elements match current UI (Evidence Type toggles, Relevance Threshold slider)
Verify Assess Evidence output structure matches actual AI-generated content
Confirm workflow descriptions match visible UI labels

Dependencies, breaking changes, and deployment notes

Related: Epic 14134 (Autogenerate Validation Report)
Related frontend PR: validmind/frontend#2378

Release notes

Added documentation for AI-assisted evidence mapping and compliance assessment features in validation reports, including the Map Evidence and Assess Evidence workflows.

Checklist

What and why
How to test
Labels applied
PR linked to Shortcut

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.

github-actions · 2026-04-30T01:52:27Z

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

github-actions · 2026-04-30T01:57:48Z

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

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

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

- 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

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.

Links to the manual compliance assessment workflow for users who prefer traditional evidence linking and assessment selection.

Changed 'From the report overview' to 'For the entire report' and removed references to non-existent 'Overview page' label.

github-actions · 2026-04-30T05:04:28Z

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

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

fenakaza1

@nrichers I left some suggestions but didn't find any issue with the doc

fenakaza1

Looks good, thanks!

sc-14812/documentation---autogenerate-val

github-actions · 2026-05-04T21:25:12Z

PR Summary

This PR introduces a new guide page titled "Map and assess evidence" in the model validation section. The new documentation provides comprehensive details on how to use AI-assisted tools for mapping evidence to validation guidelines and generating compliance assessments. It outlines the following key functionalities:

How the system scans available evidence and suggests relevant items for each guideline using relevance scores and explanations.
Step-by-step instructions on the process of mapping evidence, including toggling between evidence types (Developer Evidence and Validator Evidence), adjusting relevance thresholds, and handling suggestions at the report, section, and individual guideline levels.
Detailed guidance on assessing evidence for compliance, including generating structured assessments that include guideline assessment, validation observations, and evidence review.
Guidelines for reviewing and approving mapped evidence and generated assessments, with options to accept or dismiss suggestions in bulk or individually.

Additionally, the sidebar configuration has been updated to include a link to this new guide, ensuring easy navigation for users. The page also references screenshots to illustrate the UI components like the Map Evidence and Assess Evidence panels.

Test Suggestions

Verify that the new guide page 'Map and assess evidence' appears in the sidebar and navigates correctly when selected.
Check that all image references (e.g., map-evidence-panel.png and assess-evidence-panel.png) load properly with correct alt text.
Manually review the rendered page to ensure that all instructional steps are displayed in the correct order and format.
Confirm that the markdown formatting and YAML metadata (such as title and date) are correctly interpreted by the static site generator.

github-actions · 2026-05-04T21:48:34Z

Validate docs site

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

* 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) (#1316) * 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 --------- Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

nrichers added the documentation Improvements or additions to documentation label Apr 30, 2026

nrichers changed the title ~~docs: Add autogenerate validation reports documentation~~ Documentation: Map and assess evidence Apr 30, 2026

nrichers added 11 commits April 29, 2026 19:31

Add screenshots for Map Evidence and Assess Evidence panels

6fd4303

- 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

4374c38

- 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

Consolidate intro into benefits-focused overview section

97ee120

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

419d2ae

Remove What's next section

f393d0b

Remove unused evidence-assessment-example.png

2d852b8

Add What's next section with listing to assess-compliance

d82651e

Links to the manual compliance assessment workflow for users who prefer traditional evidence linking and assessment selection.

Document Remap Evidence button in report overview

dd84ba8

Replace 'report overview' with visible UI terminology

f90af2e

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

78dc19a

nrichers requested a review from gtagle April 30, 2026 05:18

nrichers changed the title ~~Documentation: Map and assess evidence~~ docs: Map and assess evidence Apr 30, 2026

nrichers requested a review from fenakaza1 May 1, 2026 15:27

fenakaza1 reviewed May 1, 2026

View reviewed changes

Comment thread site/guide/model-validation/map-and-assess-evidence.qmd Outdated

Comment thread site/guide/model-validation/map-and-assess-evidence.qmd

Address review comments from Fernanda

f0b52d4

nrichers requested a review from fenakaza1 May 4, 2026 20:01

fenakaza1 approved these changes May 4, 2026

View reviewed changes

nrichers added 2 commits May 4, 2026 13:46

Merge branch 'main' of github.com:validmind/documentation into nrichers/

2dbaa07

sc-14812/documentation---autogenerate-val

Fix link warning

00935f9

fenakaza1 merged commit e6a1f06 into main May 4, 2026
6 of 7 checks passed

fenakaza1 deleted the nrichers/sc-14812/documentation---autogenerate-val branch May 4, 2026 21:31

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Map and assess evidence#1299

docs: Map and assess evidence#1299
fenakaza1 merged 17 commits intomainfrom
nrichers/sc-14812/documentation---autogenerate-val

nrichers commented Apr 30, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

fenakaza1 left a comment

Uh oh!

Uh oh!

Uh oh!

fenakaza1 left a comment

Uh oh!

github-actions Bot commented May 4, 2026

Uh oh!

Uh oh!

github-actions Bot commented May 4, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

nrichers commented Apr 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

What and why?

How to test

What needs special review?

Dependencies, breaking changes, and deployment notes

Release notes

Checklist

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026

Uh oh!

github-actions Bot commented Apr 30, 2026

Lighthouse check results

Uh oh!

fenakaza1 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

fenakaza1 left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions Bot commented May 4, 2026

PR Summary

Test Suggestions

Uh oh!

Uh oh!

github-actions Bot commented May 4, 2026

Validate docs site

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

nrichers commented Apr 30, 2026 •

edited

Loading