Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 31, 2026

Documentation Update: Remove Two-File Structure Recommendation

This PR updates the agentic workflow creation and update documentation to reflect that workflows can now be edited without recompilation. The two-file structure (separating agentics/ and workflows/ directories) is no longer necessary since the markdown body can be edited directly.

Plan

  • Understand the issue requirements
  • Locate relevant documentation files
  • Update .github/aw/create-agentic-workflow.md - remove two-file structure recommendation
  • Update .github/aw/update-agentic-workflow.md - remove two-file structure recommendation
  • Update pkg/cli/templates/create-agentic-workflow.md - remove two-file structure recommendation
  • Update pkg/cli/templates/update-agentic-workflow.md - remove two-file structure recommendation
  • Build and validate documentation
  • Verify all changes are correct
  • Recompile all workflows

Changes Made

Key Updates:

  1. ✅ Replaced "two-file structure" guidance with single-file approach
  2. ✅ Emphasized that markdown body can be edited without recompilation
  3. ✅ Clarified that YAML frontmatter changes require recompilation
  4. ✅ Updated all examples to show single .github/workflows/<workflow-id>.md file structure
  5. ✅ Removed references to .github/agentics/<workflow-id>.md and runtime-import patterns
  6. ✅ Recompiled all 147 workflows (0 errors, 23 warnings)

Files Updated:

  • .github/aw/create-agentic-workflow.md (144 lines reduced)
  • .github/aw/update-agentic-workflow.md (209 lines reduced)
  • pkg/cli/templates/create-agentic-workflow.md (144 lines reduced)
  • pkg/cli/templates/update-agentic-workflow.md (209 lines reduced)
  • pkg/workflow/data/action_pins.json (updated during recompilation)

Total Impact: Reduced documentation by 199 lines while improving clarity

Documentation Build: ✅ Successfully built with no errors

Workflow Compilation: ✅ All 147 workflows compiled successfully

Summary

The documentation now correctly reflects the current workflow editing capabilities:

  • Single file structure: All workflows use .github/workflows/<workflow-id>.md
  • No recompilation needed: Markdown body can be edited directly on GitHub.com
  • Clear guidance: Users know when recompilation is required (frontmatter) vs not (markdown body)
Original prompt

Review create-agentic-workflow.md and update-agentic-workflow.md and remove any suggestion to use 2 files to create agentic workflows. Only suggest using one file since the markdown body can be edited without compilation now.

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 31, 2026 13:40
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…tion

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Update agentic workflow documentation to use one file Remove two-file structure from workflow documentation Jan 31, 2026
Copilot AI requested a review from pelikhan January 31, 2026 13:47
@pelikhan
Copy link
Contributor

@copilot recompile

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

Copilot AI commented Jan 31, 2026

@copilot recompile

Recompiled all workflows successfully. All 147 workflows compiled with 0 errors and 23 warnings. Updated pkg/workflow/data/action_pins.json in commit 9f8825e.

@pelikhan pelikhan marked this pull request as ready for review January 31, 2026 13:59
@pelikhan pelikhan merged commit 2526bbc into main Jan 31, 2026
82 of 83 checks passed
@pelikhan pelikhan deleted the copilot/update-agentic-workflow-docs branch January 31, 2026 13:59
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