ai-dev-gallery: Instructions file for GitHub Copilot

Scenario and Prompt Template Instructions

When reviewing or modifying scenarios.json or promptTemplates.json:

IMPORTANT: Source Generator Embedded Files

Both scenarios.json and promptTemplates.json are embedded at build time by Roslyn source generators. Changes to these files require a full rebuild to take effect - they are NOT loaded dynamically at runtime.

scenarios.json Structure

{
  "CategoryName": {
    "Name": "Category Display Name",
    "Icon": "\uE8BD",
    "Description": "Category description for the UI",
    "Scenarios": {
      "ScenarioName": {
        "Name": "Scenario Display Name",
        "Description": "What this scenario does",
        "Instructions": "User-facing instructions for using this sample",
        "Id": "kebab-case-unique-id",
        "Icon": "\uE8D4"
      }
    }
  }
}

Required Scenario Fields

• Name: Display name shown in UI
• Id: Unique kebab-case identifier (e.g., "summarize-text")

Optional Fields

• Description: Brief description of the scenario
• Instructions: User instructions for the sample UI
• Icon: Segoe MDL2 glyph code (e.g., "\uE8BD")

Usage in Samples

The ScenarioType enum is auto-generated from scenarios.json. Reference in [GallerySample]:

[GallerySample(
    Scenario = ScenarioType.TextSummarizeText,  // CategoryScenarioName format
    ...
)]

The naming pattern is {Category}{ScenarioName} in PascalCase.

promptTemplates.json Structure

{
  "TemplateName": {
    "system": "<|system|>\n{{CONTENT}}<|end|>\n",
    "user": "<|user|>\n{{CONTENT}}<|end|>\n",
    "assistant": "<|assistant|>\n{{CONTENT}}<|end|>\n",
    "stop": ["<|end|>", "<|user|>"]
  }
}

Required Prompt Template Fields

• user: Template for user messages with {{CONTENT}} placeholder
• stop: Array of stop sequences

Optional Prompt Template Fields

• system: Template for system prompt with {{CONTENT}} placeholder
• assistant: Template for assistant responses with {{CONTENT}} placeholder