Skip to content

[SC-16959] Documentation: workflow execution taken path and Step Detail panels#1436

Merged
cachafla merged 1 commit into
mainfrom
panchicore/sc-16959-execution-viewer-docs
Jul 24, 2026
Merged

[SC-16959] Documentation: workflow execution taken path and Step Detail panels#1436
cachafla merged 1 commit into
mainfrom
panchicore/sc-16959-execution-viewer-docs

Conversation

@panchicore

Copy link
Copy Markdown
Member

Pull Request Description

What and why?

Documents the workflow execution viewer improvements shipped in SC-16959 (frontend#2682) and its predecessor SC-16932 (frontend#2680).

Before, the Workflow tab bullet in both shared includes said only "The current workflow step is highlighted on this view." The shipped viewer does much more, none of it documented:

  • The path the execution has taken is drawn in green; branches it did not take are dimmed (line and label).
  • Clicking any visited step opens its Step Detail panel, with a run pager (Run 1 of 2) when a loop ran the step multiple times.
  • For approval steps, the panel shows the decision — Approved, Rejected, or Pending — a vote count (e.g. 2 of 3), and each participant's vote, notes, and vote time, with non-voters dimmed below the voters.
  • For user action steps, the panel shows the submitted values and who submitted them.

Edited the two shared sources (guide + RevealJS training variants kept in sync):

  • site/guide/workflows/_view-workflow-executions.qmd
  • site/guide/workflows/_review-active-workflows.qmd

Copy is anchored to the shipped code, not the ticket: the panel header is "Step Detail" (the PR diagram said "Run details"), and a pending approval does open the panel in its live Pending state (the story's AC predated that behavior).

Intentionally out of scope: per-field Set Field statuses (Set/Declined/Error), the LaunchDarkly kill-switch for the overlay (default on), and the ring/check/border visual distinction — summarized as the green taken path.

How to test

Rendered every consumer of both includes one page at a time:

skills/validmind-docs-coverage/scripts/render-pages.sh \
  guide/workflows/working-with-workflows.qmd \
  guide/workflows/manage-workflows.qmd \
  guide/documentation/submit-documents.qmd \
  training/administrator-fundamentals/organizational-oversight-reporting.qmd \
  training/developer-fundamentals/finalizing-documentation.qmd \
  training/validator-fundamentals/finalizing-validation-reports.qmd

All six rendered successfully; grepped each output in site/_site/ for the new copy (present in every variant). git diff --check clean. The validmind/validmind.qmd link warnings are pre-existing and unrelated.

Documentation preview

Review the changes live after the validate run completes:

What needs special review?

Whether the approval-panel detail level is right for the training decks — the same copy is used in all formats to keep the shared includes from diverging.

Dependencies, breaking changes, and deployment notes

None. Docs-only; the documented behavior is live (frontend#2682 merged and backported to release/26.07).

Release notes

The workflow execution viewer documentation now covers the taken-path view — the executed path in green with non-taken branches dimmed — and the Step Detail panel, including approval decisions with each participant's vote and notes. Learn more ...

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)

🤖 Generated with Claude Code

The Workflow tab bullet in both shared includes still described the
execution canvas as only highlighting the current step. Document the
taken-path overlay (green path, dimmed non-taken branches) and the
Step Detail panel: run pager for loops, approval decisions with votes,
and user action submissions.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@panchicore panchicore added the documentation Improvements or additions to documentation label Jul 24, 2026
@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

Copy link
Copy Markdown
Contributor

Validate docs site

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

@cachafla
cachafla merged commit 08f88c9 into main Jul 24, 2026
5 of 7 checks passed
@cachafla
cachafla deleted the panchicore/sc-16959-execution-viewer-docs branch July 24, 2026 20:50
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.

3 participants