Documentation for Workflows - Condition Branches

[validbeck]

Internal Notes for Reviewers

sc-6906

LIVE PREVIEW: https://docs-demo.vm.validmind.ai/pr_previews/beck/sc-6906/documentation-support-for-conditional-branching/guide/model-workflows/set-up-model-workflows.html#condition-branch

Set up model workflows

Added a Condition Branch step to the "Available step types":

Adjusted the Add conditional requirements blurb to include Condition Branch steps:

Manage model inventory fields

Updated the User field entry:

[validbeck]

@panchicore Can you please confirm if these instructions are good? If so, please approve. 🙏🏻

Live preview URL: https://docs-demo.vm.validmind.ai/pr_previews/beck/sc-6906/documentation-support-for-conditional-branching/guide/model-workflows/set-up-model-workflows.html#condition-branch

[github-actions]

PR Summary

This pull request introduces enhancements to the documentation for managing model inventory fields and setting up model workflows. The key changes include:

1. Model Inventory Fields:

   • Added a toggle option to allow linking to multiple records in the user selection list, enabling multi-selection of users.

2. Model Workflows:

   • Introduced a new section on configuring condition branches, which allows diverging paths based on conditional requirements. A default branch is automatically included as a catch-all else path.
   • Detailed steps for configuring condition branches, including adding and removing paths, and linking them to subsequent steps.
   • Provided an example of a condition branch where models with a specific field set to true undergo a special legal approval process.
   • Updated the list of step types that can have conditional requirements to include condition branches.
   • Clarified the process of linking workflow steps together, including approval steps that need to be linked to both rejected and approved status change steps.

These changes aim to improve the clarity and usability of the documentation for users managing model inventories and workflows.

Test Suggestions

• Verify that the documentation correctly describes the process of enabling multi-selection of users in the model inventory fields.
• Check the accuracy of the steps provided for configuring condition branches in model workflows.
• Ensure that the example provided for condition branches is clear and matches the described functionality.
• Test the linking of workflow steps as described, particularly the approval steps with rejected and approved status changes.

[github-actions]

PR Summary

This pull request introduces enhancements to the documentation for managing model inventory fields and setting up model workflows. The key changes include:

1. Model Inventory Fields:

   • Added a toggle option to allow linking to multiple records in the user selection list, enabling multi-selection of users.

2. Model Workflows:

   • Introduced a new section on configuring condition branches, which allows diverging paths based on conditional requirements. A default branch is automatically included as a catch-all else path.
   • Detailed steps for configuring a condition branch, including adding and removing paths, and linking branches to subsequent steps.
   • Provided an example of a condition branch where models with a specific field set to true undergo a special legal approval process.
   • Updated the list of step types that can have conditional requirements to include the new Condition Branch type.
   • Clarified the process of linking approval steps to both Rejected and Approved status change steps.

These changes aim to improve the clarity and usability of the documentation for users managing model inventories and workflows.

Test Suggestions

• Verify that the documentation correctly describes the process of enabling multi-selection in the user selection list.
• Check the accuracy of the steps provided for configuring condition branches in model workflows.
• Ensure that the example provided for condition branches is clear and matches the described functionality.
• Test the linking of approval steps to Rejected and Approved status change steps as described in the documentation.

[panchicore]

Yes. 🌞