Skip to main content

Design Recipes

Manage Design Recipes​

The Design recipes section in Admin Settings allows administrators to manage general design recipes that are used by the Design Assistant, bundling up skills and commands. Each recipe version is displayed as an individual card with its metadata and lifecycle status.

❗️info

This section provides an overview of existing design recipes and enables import/export operations. For detailed information about design recipe concepts and structure, see Design recipes.

Viewing Design Recipes​

The recipes overview displays all available recipe versions as cards or table rows, showing:

  • Icon: Visual identifier from the recipe specifications
  • Name: Display name of the recipe
  • Description: Human-readable description
  • Version number: Semantic version (e.g., 1.0.0)
  • Tags: Categorization tags for filtering and organization

With a click on a design recipe, you can view additional information, such as the baselines the recipe is used in.

Adding a New Design Recipe​

To add a new design recipe:

  1. Click the Add design recipe button
  2. In the sidebar that opens, upload a ZIP bundle containing your skills and commands
  3. Click Add to upload (or Cancel to abort)

Validation​

When adding a design recipe, the system validates:

  • File format: Must be ZIP containing valid YAML files
  • Recipe structure: The YAML must conform to the design recipe schema
  • Required fields: All mandatory recipe attributes must be present

If validation fails, appropriate error messages are displayed.

Managing Recipe Lifecycle​

Each design recipe card or row provides an overflow menu with the following operations:

Upload New File​

Icon: Upload Availability: Always available

Allows you to replace the recipe file with an updated version. Opens the same upload dialog as adding a new design recipe.

Download File​

Icon: Download Availability: Always available

Downloads the recipe ZIP file to your local machine. Useful for:

  • Creating backups
  • Sharing design recipes with other teams
  • Using as templates for new design recipes
  • Version control and collaboration

Best Practices​

  • Version incrementally: Create new versions with semantic versioning rather than modifying already used design recipes
  • Document clearly: Use descriptive names, descriptions, and tags
  • Backup regularly: Download recipe files periodically for disaster recovery
  • Follow naming conventions: Use consistent ID patterns (e.g. business-intent-sync)