Docs Copilot

Deploying a recipe to production involves multiple contributors and various activities beyond the building and testing phases. One crucial activity is documenting your recipes using detailed descriptions. These descriptions enable administrators to comprehend each recipe's functionality and assist team members in extending your recipes in the future.

Docs Copilot generates initial recipe descriptions. This allows you to concentrate more on delivery and less on documentation.

Prerequisites

• Ensure that you have Copilot enabled for your workspace. Enabling Copilots requires an Admin system role. If you are not assigned this role, contact your workspace administrator to enable this feature. For more information, refer to our Copilots documentation.

PERMISSIONS

Copilots do not have granular permission settings. When you enable it in your workspace, all collaborators within your workspace can access it, regardless of their role.

Generate your recipe descriptions

After you save, test, and debug your recipe, you can use Docs Copilot to help you generate your recipe in the following situations:

• When no recipe description is present
• When a recipe description is present

No recipe description is present

Complete the following steps to generate a recipe description using Docs Copilot:

1

Click Add description to immediately trigger Docs Copilot to generate a recipe description.

Trigger copilot with no description

2

Edit the description as required in the popup.

3

Click Save to include the edited description in the recipe, or Clear description if you choose not to use it. This description serves as a draft that you can modify as needed.

Generate recipe description

Recipe description is present

Complete the following steps to generate a new recipe description using Docs Copilot:

1

Click Edit to open the recipe description popup.

Trigger copilot with existing description

2

Use Docs Copilot to generate a new description in the popup.

3

Review the generated description. If it meets your requirements, Save it. You can revert the generation if it does not meet your requirements.

How it works

Docs Copilot generates a description by receiving information about your recipe, excluding job data. Specifically, Docs Copilot uses the recipe steps, which are the individual actions and triggers that make up your recipe, the input fields where data is entered or mapped, and the applications integrated within your recipe. If your recipe calls other recipes, Docs Copilot also gathers information about those linked recipes to provide a more accurate generation.

You can improve the recipe descriptions that Docs Copilot generates by providing relevant names for all custom actions or HTTP actions in your recipe.

Data usage

Refer to our appendix to see the data that Docs Copilot uses. Learn more.