Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 26, 2026

Update "Creating Workflows" Documentation

  • Explore repository structure and locate target file
  • Review current documentation content
  • Review copilot-setup.md for reference
  • Update page title from "Creating Workflows" to "Agentic Authoring of Workflows"
  • Update description to reflect web interface approach
  • Remove VS Code dependency mentions
  • Update step 1 to use GitHub agentic session with copilot-setup.md prompt
  • Add clarification about editing markdown body vs frontmatter (compilation requirement)
  • Update sidebar navigation label to "Agentic Authoring"
  • Test documentation build with make build-docs
  • Verify all links and formatting are correct
  • Address PR feedback: Remove TIP callout and emphasize GitHub Copilot
  • Add recommended workflow editing approach using agentic-workflows agent

Changes Made

Title and Navigation

  • Changed page title from "Creating Workflows" to "Agentic Authoring of Workflows"
  • Updated sidebar navigation label to "Agentic Authoring"
  • Updated description to emphasize GitHub web interface

Quick Start Section

  • Changed initialization from local gh aw init command to GitHub Copilot agent session approach
  • Users now start with prompt: "Initialize the repository for GitHub Agentic Workflows using https://github.com/githubnext/gh-aw/blob/main/copilot-setup.md"
  • Emphasized that everything can be done through the GitHub web interface without VS Code

Editing Workflows Section (New)

Added comprehensive guidance on editing workflows with two approaches:

Recommended: Using the Agentic-Workflows Agent

  • Primary method for editing workflows using /agent agentic-workflows command
  • Automatically handles both content changes and recompilation
  • Example: /agent agentic-workflows update add web-fetch tool to my-workflow

Manual Editing: Prompt vs Frontmatter

  • Markdown body (prompt): Can be edited directly from GitHub web interface in .github/workflows/*.md files without recompilation
  • Frontmatter (YAML config): Requires recompilation with gh aw compile after manual edits (or use the agent instead)
  • Includes comparison table and examples for both components

Content Refinements

  • Removed TIP callout about VS Code to streamline web interface focus
  • Updated introduction to state "This experience uses GitHub Copilot"
  • VS Code positioned as optional rather than required

Build Status

✅ Documentation built successfully (102 pages indexed)
✅ All internal links validated
✅ No errors or warnings

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using GitHub Docs voice

Original prompt

Update the documentation page "Creating Workflow"

  • new title "Agentic Authoring of Workflows"

  • VSCode is NOT needed, everything can be done thourhg the github web interface

  • step 1 to install aw, start a agentic session in github.com with the prompt

    Initialize the repository for GitHub Agentic Workflows using https://github.com/githubnext/gh-aw/blob/main/copilot-setup.md

  • editing of the markdown text body (prompt) vs front matter which requires recompilation.

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using GitHub Docs voice


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI and others added 3 commits January 26, 2026 21:50
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…interface approach

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
@pelikhan pelikhan marked this pull request as ready for review January 26, 2026 21:54
Copilot AI changed the title [WIP] Update documentation for creating workflow Update workflow authoring docs to emphasize GitHub web interface Jan 26, 2026

## After compiling
## Editing Workflows: Prompt vs Frontmatter

Copy link
Contributor

Choose a reason for hiding this comment

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

Prompt the user to use the "agentic-workflows" agent to edit the workflow, this will also recompile the workflow.

However, they can edit the markdown body of the agentics/*.md file from the web interface without recompilation.

Copy link
Contributor

Choose a reason for hiding this comment

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

@copilot Prompt the user to use the "agentic-workflows" agent to edit the workflow, this will also recompile the workflow.

However, they can edit the markdown body of the agentics/*.md file from the web interface without recompilation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the "Editing Workflows" section in commit 7d618df to:

  1. Recommend using /agent agentic-workflows as the primary editing method (handles recompilation automatically)
  2. Clarify that markdown body can be edited directly from the GitHub web interface without recompilation
  3. Note that manual frontmatter edits require recompilation, or users can use the agent instead

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

Copilot AI commented Jan 26, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

…kflows

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

Copilot AI commented Jan 26, 2026

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

@pelikhan pelikhan merged commit d8a2264 into main Jan 26, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/update-creating-workflow-docs branch January 26, 2026 22:15
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