diff --git a/docs/user-guide/assistants/assistant-categories-management.md b/docs/user-guide/assistants/assistant-categories-management.md index 40be19df..2eef139c 100644 --- a/docs/user-guide/assistants/assistant-categories-management.md +++ b/docs/user-guide/assistants/assistant-categories-management.md @@ -47,10 +47,10 @@ When editing a category with assigned assistants, a warning displays showing: ## Delete Category -**Delete is disabled** for categories with any assigned assistants. +**Delete is disabled** for categories with any assigned assistants or [workflows](../workflows/create-workflow.md#workflow-categories). To delete: -1. Reassign all assistants to other categories +1. Reassign all assistants and workflows to other categories 2. Click **Delete** button (trash icon) 3. Confirm deletion diff --git a/docs/user-guide/workflows/create-workflow-from-template.md b/docs/user-guide/workflows/create-workflow-from-template.md index 716a69b0..4c9f5628 100644 --- a/docs/user-guide/workflows/create-workflow-from-template.md +++ b/docs/user-guide/workflows/create-workflow-from-template.md @@ -45,6 +45,7 @@ Creating a workflow from scratch can be complex, especially for first-time users | **Name** | Unique name for the workflow | | **Description** | Brief description of the workflow's features and purpose | | **Icon URL** | URL to an icon image for the workflow avatar | +| **Categories** | Optional. Up to 3 categories that describe the workflow's use case | | **Supervisor Prompt** | Global context shared across all assistants; can include variables like date, time, etc. | 7. Click **Create** to save your workflow. diff --git a/docs/user-guide/workflows/create-workflow.md b/docs/user-guide/workflows/create-workflow.md index 602b1498..a092e49c 100644 --- a/docs/user-guide/workflows/create-workflow.md +++ b/docs/user-guide/workflows/create-workflow.md @@ -107,11 +107,27 @@ Configure essential workflow settings: - **Description**: Brief explanation of the workflow's purpose and features - **Start Hint**: Custom text displayed below the prompt input field when users start a workflow execution. - **Icon URL**: Link to an image (.png or .svg) for the workflow avatar +- **Categories**: Optional. Select up to 3 categories that describe the workflow's use case. The list is the same as for assistants. See [Workflow Categories](#workflow-categories). :::info Required Fields Fields marked with an asterisk (\*) are required and must be filled in before saving the workflow. ::: +#### Workflow Categories + +The **Categories** field is a multi-select dropdown located below **Icon URL** in the workflow configuration. The same field is available in the create/edit form and in the **Basic** tab of the Visual Editor **Workflow Config** menu. + +![Categories field in the workflow configuration](./images/workflow-config-categories-field.png) + +- Selecting categories is optional. A workflow can be saved with no categories. +- A maximum of 3 categories can be selected. Once 3 are chosen, additional options cannot be selected until one is removed. +- Selected categories are saved with the workflow and pre-filled when the workflow is edited again. +- Categories assigned here are used to [filter workflows](./workflows-overview.md#filtering-workflows-by-category) on the **My Workflows** and **All Workflows** pages. + +:::note +Categories are managed centrally and shared with assistants. See [Assistant Categories Management](../assistants/assistant-categories-management.md). Categories selected here are independent of the categories chosen when [publishing to the Marketplace](./marketplace-publishing.md#selecting-categories). +::: + **Advanced Tab:** ![Advanced Configuration](./images/visual-editor-advanced-config.png) diff --git a/docs/user-guide/workflows/images/workflow-config-categories-field.png b/docs/user-guide/workflows/images/workflow-config-categories-field.png new file mode 100644 index 00000000..db78261a Binary files /dev/null and b/docs/user-guide/workflows/images/workflow-config-categories-field.png differ diff --git a/docs/user-guide/workflows/images/workflows-overview/workflows-categories-filter.png b/docs/user-guide/workflows/images/workflows-overview/workflows-categories-filter.png new file mode 100644 index 00000000..31362e05 Binary files /dev/null and b/docs/user-guide/workflows/images/workflows-overview/workflows-categories-filter.png differ diff --git a/docs/user-guide/workflows/marketplace-publishing.md b/docs/user-guide/workflows/marketplace-publishing.md index 6461baf0..a2f38077 100644 --- a/docs/user-guide/workflows/marketplace-publishing.md +++ b/docs/user-guide/workflows/marketplace-publishing.md @@ -62,6 +62,10 @@ Choose 1 to 3 categories that best describe the workflow's purpose. Categories h At least one category is required. Attempting to publish without a category selection results in a validation error. ::: +:::note +These categories are selected at publish time. They are separate from the optional [categories set in the workflow configuration](./create-workflow.md#workflow-categories). +::: + ## After Publishing Once published, the workflow becomes globally visible in the **Marketplace** tab of the Workflows section. Any authenticated user can view and execute it. diff --git a/docs/user-guide/workflows/workflows-overview.md b/docs/user-guide/workflows/workflows-overview.md index a44c5eed..a13e998f 100644 --- a/docs/user-guide/workflows/workflows-overview.md +++ b/docs/user-guide/workflows/workflows-overview.md @@ -49,6 +49,19 @@ To open the Workflow Details page, select **View Details** from the actions menu ![View Details option in workflow actions](./images/workflows-overview/workflow-actions-view-details.png) +## Filtering Workflows by Category + +The **My Workflows** and **All Workflows** pages include a **Categories** filter in the left sidebar. It uses the same categories as assistants and works with categories assigned in the workflow's [configuration](./create-workflow.md#workflow-categories). + +![Categories filter on the My Workflows page](./images/workflows-overview/workflows-categories-filter.png) + +1. Open **My Workflows** or **All Workflows**. +2. In the left sidebar, open the **Categories** dropdown. +3. Select one or more categories. The list updates to show only workflows that have a selected category assigned. +4. To restore the full list, clear the selected categories. + +Workflows without categories are hidden while a category filter is applied and are shown again when the filter is cleared. + ## Workflow Details Page The Workflow Details page is the central hub for viewing, running, and managing a specific workflow. diff --git a/faq/can-i-delete-a-category-that-is-used-by-workflows.md b/faq/can-i-delete-a-category-that-is-used-by-workflows.md new file mode 100644 index 00000000..8bea070b --- /dev/null +++ b/faq/can-i-delete-a-category-that-is-used-by-workflows.md @@ -0,0 +1,7 @@ +# Can I delete a category that is used by workflows? + +No. A category cannot be deleted while any assistant or workflow uses it. The error message lists how many assistants and workflows use the category, along with up to 10 names of each. Reassign them to other categories first, then delete the category. + +## Sources + +- [Assistant Categories Management](https://codemie-ai.github.io/docs/user-guide/assistants/assistant-categories-management) diff --git a/faq/how-do-i-assign-categories-to-a-workflow-and-filter-workflows-by-category.md b/faq/how-do-i-assign-categories-to-a-workflow-and-filter-workflows-by-category.md new file mode 100644 index 00000000..00521a18 --- /dev/null +++ b/faq/how-do-i-assign-categories-to-a-workflow-and-filter-workflows-by-category.md @@ -0,0 +1,10 @@ +# How do I assign categories to a workflow and filter workflows by category? + +Categories are optional and can be set when a workflow is created or edited. In the workflow configuration, open the **Categories** dropdown (below **Icon URL**) and select up to 3 categories. The same list of categories is used for assistants. + +To filter, open **My Workflows** or **All Workflows** and select one or more categories in the **Categories** filter in the left sidebar. Only workflows with a selected category are shown; workflows without categories are hidden until the filter is cleared. + +## Sources + +- [Create Workflow](https://codemie-ai.github.io/docs/user-guide/workflows/create-workflow#workflow-categories) +- [Workflows Overview](https://codemie-ai.github.io/docs/user-guide/workflows/workflows-overview#filtering-workflows-by-category)