Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Feb 4, 2026

The documentation lacked discovery paths for shared workflow components like orchestration and monitoring patterns. Users had no clear entry point to learn about composition via imports or the helper files available after installation.

Changes

create.md

  • Added "Use Shared Agentic Workflows" subsection under Step 2 (following the existing pattern of other subsections like "Create New Workflow", "Update Existing Workflow", etc.)
  • Documented orchestration pattern (dispatch-workflow, assign-to-agent)
  • Documented monitoring pattern (update-project, create-project-status-update)
  • Included discovery instructions for .github/workflows/shared/
  • Added "Available After Installation" documentation for:
    • Workflow prompt files in .github/aw/ (create, update, debug, upgrade, create-shared)
    • Agent files in .github/agents/ (dispatcher agent)
    • Explanation of how these files guide AI assistants in workflow development
  • Fixed code examples with proper quoting for consistency

Structure

The "Use Shared Agentic Workflows" subsection follows the same pattern as other Step 2 subsections with:

  • Load when: Describes when to use this section
  • Use cases: Example user requests
  • Content: Comprehensive documentation on shared components

Example

Users can now compose workflows from shared components:

---
imports:
  - shared/orchestration.md
  - shared/projects.md
safe-outputs:
  dispatch-workflow:
    workflows: [worker-a, worker-b]
    max: 10
  update-project:
    project: "https://github.com/orgs/myorg/projects/123"
    max: 10
---

Orchestration delegates to specialized workers. Monitoring tracks progress in GitHub Projects. Both patterns were already implemented in .github/workflows/shared/ but undiscoverable.

The subsection is now easily referenceable by create workflow, update workflow, and other workflow-related prompts that follow the create.md dispatch pattern.

Original prompt

Could the documentation and create.md benefit from a section called "reusable components" (like orchestration and monitoring)?


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add reusable components section to documentation Add reusable components section to documentation Feb 4, 2026
Copilot AI requested a review from mnkiefer February 4, 2026 08:26
@mnkiefer
Copy link
Contributor

mnkiefer commented Feb 4, 2026

@copilot only focus on create.md and remove other changes. We want the prompt to be available of shared imports so that it can use the in create workflow, update workflow, etc.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 4, 2026

@copilot only focus on create.md and remove other changes. We want the prompt to be available of shared imports so that it can use the in create workflow, update workflow, etc.

Done. Removed changes to packaging-imports.md. Now only create.md has the reusable components section (commit a772aec).

The reusable components documentation is now available in create.md where it can be referenced by create workflow, update workflow, and other workflow prompts.

Copilot AI changed the title Add reusable components section to documentation Add reusable components section to create.md Feb 4, 2026
@mnkiefer
Copy link
Contributor

mnkiefer commented Feb 4, 2026

@copilot Check if there are other shareable workflows or instructions that are available to the user after install/create in a fresh repo.

@mnkiefer mnkiefer marked this pull request as ready for review February 4, 2026 10:17
Copilot AI review requested due to automatic review settings February 4, 2026 10:17
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR enhances the create.md documentation by adding a comprehensive "Reusable Components" section that helps users discover and utilize shared workflow components. The documentation was previously missing clear guidance on how to compose workflows using imports.

Changes:

  • Added a new "Reusable Components" section with subsections covering common patterns (orchestration, monitoring, reporting), discovery instructions, import usage, and links to related guides
  • Positioned the section between Step 2 (workflow creation) and Step 3 (review), providing contextual information at the right point in the workflow creation process
  • Included practical YAML examples demonstrating how to import and configure shared components
Comments suppressed due to low confidence (1)

create.md:152

  • The project URL should be enclosed in quotes for consistency with examples throughout the codebase. The shared/projects.md file and actual workflow examples consistently use quotes around project URLs.
    project: https://github.com/orgs/myorg/projects/123
    max: 1

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

create.md Outdated
- shared/projects.md
safe-outputs:
update-project:
project: https://github.com/orgs/myorg/projects/123
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The project URL should be enclosed in quotes for consistency with examples throughout the codebase. The shared/projects.md file and actual workflow examples consistently use quotes around project URLs.

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in commit 373ae7a. Project URLs now have quotes.

create.md Outdated
workflows: [worker-a, worker-b]
max: 10
assign-to-agent:
name: copilot
Copy link

Copilot AI Feb 4, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The value for the name field should be enclosed in quotes for consistency with the reference documentation in shared/orchestration.md, which shows name: "copilot".

Copilot uses AI. Check for mistakes.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed in commit 373ae7a. Changed to name: "copilot" with quotes.

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 4, 2026

@copilot Check if there are other shareable workflows or instructions that are available to the user after install/create in a fresh repo.

Added "Available After Installation" section documenting the workflow prompt files and agent files created by gh aw init (commit 8954b8d).

The section now covers:

  • Workflow prompt files in .github/aw/ (create, update, debug, upgrade, create-shared)
  • Agent files in .github/agents/ (dispatcher agent)
  • Explanation that these files guide AI assistants in workflow development

Combined with the existing documentation on .github/workflows/shared/ components, this provides a complete picture of shareable resources available after installation.

@mnkiefer
Copy link
Contributor

mnkiefer commented Feb 4, 2026

@copilot No separate section, this goes against the main pattern of create.md. But maybe a section on "Use Shared Agentic Workflows" that other sectioms can see when creating/updating a workflow?

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Feb 4, 2026

@copilot No separate section, this goes against the main pattern of create.md. But maybe a section on "Use Shared Agentic Workflows" that other sectioms can see when creating/updating a workflow?

Restructured in commit 373ae7a. Removed the separate "Reusable Components" section and created "Use Shared Agentic Workflows" as a subsection under Step 2, following the same pattern as "Create New Workflow", "Update Existing Workflow", etc.

The subsection includes:

  • "Load when" and "Use cases" sections consistent with other subsections
  • All the orchestration, monitoring, and shared component documentation
  • Can now be referenced by other sections when creating/updating workflows

Copilot AI changed the title Add reusable components section to create.md Add "Use Shared Agentic Workflows" subsection to create.md Feb 4, 2026
@mnkiefer
Copy link
Contributor

mnkiefer commented Feb 4, 2026

@mnkiefer mnkiefer closed this Feb 4, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants