Workflow capacity docs - #1467
Open
kam-validmind wants to merge 3 commits into
Open
Conversation
Contributor
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request Description
What and why?
Documents the workflow-execution "assign a stakeholder" feature set (internally tracked as capacity planning for workflow assignment) that has already shipped to
mainin bothbackendandfrontend, spanning SC-17687–17690, SC-17692, SC-17693, SC-17837, and (partially — see below) SC-17838. There was previously no user documentation for any of this.New page —
guide/workflows/assign-workflow-executions.qmd, added as a new card in Guides → Workflows → Working with workflows, covering:Updated existing pages to surface the same capability where it now shows up in the product:
_initiate-workflows.qmd— the Stakeholder field on the Run Workflow dialog, on both the records and artifacts tabs._view-workflow-executions.qmd— the View-by-Assignee toggle, the assignee filter, the Export action, the tooltip, and the editable Details tab._review-active-workflows.qmd— the editable Details tab, reached from a record's or artifact's own Active Workflows section.Both edited files carry the guide's dual HTML/training(revealjs) content, so each addition is duplicated into both blocks.
Also regenerated
site/llm/chatbot-product-map.mdand its frontend snapshot (make -C site refresh-chatbot-product-map, against a freshlymain-syncedfrontendcheckout) so the in-app assistant's route map picks up the new page under/workflowsand/settings/workflows.How to test
Render the touched pages locally:
All three render clean (verified this session — only the pre-existing, unrelated
Unable to resolve link target: validmind/validmind.qmdwarning).Live preview, once the PR preview build finishes:
On each, confirm: the new page appears in the sidebar and the grid listing after "Manage workflow tasks"; cross-reference links resolve (
manage-workflows.qmd#initiate-workflows,working-with-workflows.qmd#view-all-workflow-executions,manage-record-stakeholder-types.qmd#manage-stakeholder-types-on-records); and the training/revealjs profile still renders the same content without footnotes.What needs special review?
ExecutionStatus/canEditExecutionSchedulegating) rather than a live click-through against a running stack. Worth a check against the actual product before merging.launchdarklyRolloutRiskTierEngineWorkflows, default off) that isn't documented as a feature anywhere in the site yet, including the recently-shipped Risk Tiering section. Documenting stakeholder assignment there first would require documenting that assessment workflows exist at all.chatbot-product-map.mddiff is broader than this feature: the committed snapshot was stale against an olderfrontendmain, so regenerating it also fixed a pre-existing broken reference (a deleted SSO page that now honestly reads "no matching.qmdsource found" instead of pointing at nothing) and surfaced several unrelated new routes (/agent-authority/*,/risk-intelligence,/settings/risk-tier-stages) that simply didn't exist last time this was regenerated. None of that is scope creep from this PR's content — it's a byproduct of syncing to currentmain.Dependencies, breaking changes, and deployment notes
Documents already-merged engineering work; no companion PR required, no migrations, no environment variables.
Release notes
Added documentation for assigning a stakeholder to a workflow run, editing it afterward, and viewing, filtering, and exporting workflows by assignee. Learn more ...
Checklist
quarto render, not click-tested against a live preview or running stack; see "What needs special review"