Skip to content

[SC-16950] Document the workflows list table and workflow details page - #1484

Draft
emmavdh wants to merge 1 commit into
mainfrom
emma/sc-16950/workflow-details-page-docs
Draft

[SC-16950] Document the workflows list table and workflow details page#1484
emmavdh wants to merge 1 commit into
mainfrom
emma/sc-16950/workflow-details-page-docs

Conversation

@emmavdh

@emmavdh emmavdh commented Aug 27, 2026

Copy link
Copy Markdown
Collaborator

Pull Request Description

Important

Draft — iterating with screenshots to follow, and the details page ships behind a LaunchDarkly flag. launchdarkly.rollout.workflows-details-page is being flipped off by default in validmind/frontend#2844, so the details page is only live where LD explicitly serves it. Confirm the flag will be enabled for 26.09 before merging.

What and why?

Documents sc-16950 — the redesigned Settings → Workflows list and the new workflow details page (tracker: sc-17996 / Docs 26.09). Shipped in validmind/frontend#2803 and validmind/backend#3463, both merged.

Previously, clicking a workflow in Settings opened the canvas editor directly. Workflows now land on a details page that separates reviewing/monitoring a workflow from editing its configuration.

Summary of changes

  • Setting up workflows — Refreshed View, sort, and filter workflows for the unified table: the column list (ID, Name, Status, Created By, Target, Target Type, Description, Trigger, Actions), search by workflow name, and the workflow count. Added a new View workflow details section covering the properties rail and its actions (Edit Details / Clone / Publish / Delete), version history browsing, the read-only workflow diagram with Edit Workflow, and the Active Executions table.
  • Configure workflows — Clone, edit, and delete flows updated for the new experience: clone/delete via the Actions column kebab (with the details-page alternative noted), editing routed through the details page's Edit Workflow button (with Edit Details for metadata), and a new step noting that closing the editor returns you to the details page. Also fixed a pre-existing gap in the clone steps (the "select Workflows" step was missing).
  • _configure-workflow-steps.qmd (shared include, HTML + revealjs blocks) — Step navigation now goes list → details page → Edit Workflow → canvas.
  • _publish-workflows.qmd (shared include) — "Hover over" updated to match the table, and the details-page publish path added.

The section heading and anchor #view-sort-and-filter-workflows were deliberately kept stable — several pages footnote it.

How to test

Try the live preview (allow time for the PR preview deploy to finish):

All three pages render clean locally with quarto render --profile development (only the pre-existing validmind/validmind.qmd warning). Verified in the rendered HTML: the #view-workflow-details anchor resolves, all five new footnotes render (no literal [^n] markers), and the training deck picks up the new editor step exactly once.

What needs special review?

  • UI labels were verified against the merged frontend source (WorkflowDetailsPage, WorkflowExecutionsTable, list tableColumns), not a live click-through: Edit Details / Clone Workflow / Publish Workflow / Delete Workflow, the rail fields (Target, Target Type, Status, Workflow Start, Expected Duration), the Version drop-down, Edit Workflow, and the Active Executions columns (Name, Stage, Record Owner). Worth a check against the live UI once the flag is on.
  • Flag interplay: the docs describe the details-page experience as the default. With workflows-details-page off, clicking a workflow still opens the canvas directly (the old flow). Also note the Status and Created By columns are separately gated on workflows-draft-status.
  • No screenshots yet — the redesigned list and the details page are new UI; screenshots will be added while this PR is in draft.

Dependencies, breaking changes, and deployment notes

  • Implements docs for: validmind/frontend#2803 (merged), validmind/backend#3463 (merged).
  • Gated by: validmind/frontend#2844 — flips the workflows-details-page offline default to off; docs should not go live to prod before the flag is enabled for the release.
  • No dependency on any other docs PR; no file overlap with the other open 26.09 docs PRs.

Release notes

The Settings → Workflows page now lists all workflows in a single table you can search, sort, and filter — and clicking a workflow opens a new details page where you can review its properties, browse version history, preview the workflow diagram, and monitor active executions before opening the editor. Learn more ...

Checklist

  • What and why
  • Screenshots or videos (Frontend) — to be added in draft, see What needs special review
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend) — n/a
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required) — n/a

Documents the redesigned Settings > Workflows list (unified table with
search, sort, filter, and count) and the new workflow details page
(properties rail, version history, read-only diagram with Edit Workflow,
and active executions), and routes the clone/edit/delete/publish flows
through the new experience.

Co-Authored-By: Claude Fable 5 <[email protected]>
@emmavdh emmavdh added the documentation Improvements or additions to documentation label Aug 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant