Skip to content

documentation: Save drafts for workflow user action submissions#1291

Merged
validbeck merged 3 commits intomainfrom
beck/sc-15382/documentation-save-button-for-user-action
Apr 24, 2026
Merged

documentation: Save drafts for workflow user action submissions#1291
validbeck merged 3 commits intomainfrom
beck/sc-15382/documentation-save-button-for-user-action

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Apr 24, 2026

Pull Request Description

What and why?

sc-15382

You can now save drafts of the submission info when transitioning a workflow using a user action step. Docs updated to reflect this functionality.

How to test

Click on the live previews:

What needs special review?

n/a

Dependencies, breaking changes, and deployment notes

Note

Wording for models > records are being covered in other Stories; trying to avoid fewer merge conflicts in this one.

Release notes

Covered by https://github.com/validmind/frontend/pull/2413.

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 validbeck self-assigned this Apr 24, 2026
@validbeck validbeck added the internal Not to be externalized in the release notes label Apr 24, 2026
@validbeck validbeck requested review from jamadriz and nrichers April 24, 2026 19:26
Copy link
Copy Markdown

@jamadriz jamadriz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

only thing that maybe we want to make more explicit:
when clicking Save, the fields are updated (all users with read access to record, will see updated values), so not technically a "draft". Main difference is that a workflow transition won't take place

@validbeck
Copy link
Copy Markdown
Collaborator Author

only thing that maybe we want to make more explicit:
when clicking Save, the fields are updated (all users with read access to record, will see updated values), so not technically a "draft". Main difference is that a workflow transition won't take place

@jamadriz Gotcha, updated the wording and added a little more info:

Screenshot 2026-04-24 at 3 17 11 PM

@github-actions
Copy link
Copy Markdown
Contributor

PR Summary

This PR updates the documentation for workflow transitions by introducing an additional step that allows users to save a working copy of the input data. Previously, users were instructed to enter their notes and click the custom action button in a single step. With these changes, the documentation now clearly outlines that:

  1. Users can enter their notes and/or additional inventory fields and then click Save to store a working copy without triggering the workflow state transition.
  2. After saving, users need to click the custom action button (labeled {action}) to proceed with the formal transition.

An additional footnote has been added to explain the behavior of submission drafts (working copies), including details on tracking under model activity, shared accessibility among users with the appropriate permissions, and the update behavior for field values. These enhancements help ensure that users have a clear understanding of the workflow options, particularly when they need to review or revise submitted information before final submission.

Test Suggestions

  • Verify that the 'Save' button and action button are both visible and rendered correctly in the updated documentation.
  • Check that the footnote for submission drafts is displayed correctly and that the links (e.g., 'View model activity') direct to the correct pages.
  • Test the user flow in the documentation to ensure consistency across different sections such as generic workflows, models, and artifacts.
  • Ensure that the new instructions do not conflict or overlap with existing workflow actions and that the guidance is clear to end users.

@github-actions
Copy link
Copy Markdown
Contributor

Validate docs site

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

@validbeck validbeck merged commit 6af8ba4 into main Apr 24, 2026
6 of 7 checks passed
@validbeck validbeck deleted the beck/sc-15382/documentation-save-button-for-user-action branch April 24, 2026 22:50
nrichers added a commit that referenced this pull request May 2, 2026
* Edit: Managing your organization > Manage document defaults (#1268)

* docs: Settings redesign / overhaul (#1266)

* 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

* docs: Edit active workflow end dates (#1270)

* WIP

* Edit: Manage workflows > Update active workflows

* docs: add HTTP proxy guide for ValidMind Library

- New page covering proxy env vars and troubleshooting
- Link from ValidMind Library sidebar

* Edits

* docs: View, sort, and filter workflows (#1273)

* 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

* Address review comments from Spencer

* Edit

* Final edits

* Start attestations FAQ & explain attestation visibility before period starts

* docs(attestation): tighten callout wording for sidebar visibility

* Add new export option, fix smallercaps placement

* Webhook secrets updates (#1282)

* Initial draft with edits

* Edits after testing

* Fix render warnings

* 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

---------

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
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>
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