Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 15, 2026

Fix Broken Documentation Link in Issue Footer

Problem: The usage guide link in issue footers pointed to a non-existent URL (/tools/cli/). Users clicking this link received a 404 instead of documentation on adding workflows from other repositories.

Solution: Update the link to point to the correct Packaging & Distribution guide

Plan

  • Identify the broken link location (found in generate_footer.cjs)
  • Update the link to point to /gh-aw/guides/packaging-imports/ (the correct tutorial for adding workflows)
  • Update the corresponding test expectations
  • Run JavaScript formatting and linting
  • Verify the changes with manual testing
  • Run full validation with make agent-finish
  • Extract workflow install note to markdown template file per review feedback

Changes Made

  • actions/setup/md/workflow_install_note.md - Created markdown template for workflow install note
  • actions/setup/js/generate_footer.cjs - Updated to read from markdown template instead of inline text
  • actions/setup/js/generate_footer.test.cjs - Updated test to create template file in test environment

Note: Pre-existing test failures in pkg/workflow (action pin resolution tests) are unrelated to this PR's changes and were not caused by the documentation link fix.

Original prompt

Usage guide link inserted in footer of issues has broken link.

https://githubnext.github.io/gh-aw/tools/cli/

It should point to a tutorial on how to add agentic workflows from other repos using the cli or the agent


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 3 commits January 15, 2026 13:36
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
…mports guide

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] Fix broken usage guide link in footer of issues Fix broken documentation link in issue footer Jan 15, 2026
Copilot AI requested a review from pelikhan January 15, 2026 13:46
@pelikhan
Copy link
Contributor

@copilot move broken link note text to a markdown file in actions/setup/md

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

Copilot AI commented Jan 15, 2026

@copilot move broken link note text to a markdown file in actions/setup/md

Done. The workflow install note text has been moved to actions/setup/md/workflow_install_note.md and generate_footer.cjs now reads from this template file. (d984e10)

@pelikhan
Copy link
Contributor

@copilot format, lint js

Copy link
Contributor Author

Copilot AI commented Jan 15, 2026

@copilot format, lint js

✅ JavaScript formatting and linting completed successfully. All files already conform to the code style - no changes needed.

@pelikhan pelikhan marked this pull request as ready for review January 15, 2026 14:13
@pelikhan pelikhan merged commit 8eb7054 into main Jan 15, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/fix-broken-footer-link branch January 15, 2026 14:13
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