Skip to content

Comments

Fix docs build strict-mode failure and add missing gh auth prerequisite#317

Merged
strawgate merged 3 commits intomainfrom
copilot/fix-workflow-docs-links
Feb 21, 2026
Merged

Fix docs build strict-mode failure and add missing gh auth prerequisite#317
strawgate merged 3 commits intomainfrom
copilot/fix-workflow-docs-links

Conversation

Copy link
Contributor

Copilot AI commented Feb 21, 2026

Summary

Fixes the docs build strict-mode failure caused by broken cross-workflow links in generated workflow pages, and documents the missing GitHub CLI authentication prerequisite for quick setup.

Changes

  • docs/hooks.py

    • During generated-page creation, rewrites sibling workflow links from:
      • ../(workflow)/README.md(workflow).md
      • ../(workflow)/(workflow).md
    • This keeps source README links unchanged while making links resolve correctly in the generated docs under docs/workflows/gh-agent-workflows/.
  • README.md

    • Updates quick-setup prerequisites to explicitly require gh to be authenticated via gh auth login.

Notes

The workflow pages referenced from workflows/gh-agent-workflows.md are generated at build time by docs/hooks.py; this PR fixes broken links inside those generated pages rather than adding static files.

Fixes #314

Generated by Update PR Body

- docs/hooks.py: Rewrite inter-workflow links (../slug/README.md and
  ../slug/) to slug.md when generating docs pages, fixing the strict-mode
  build failure from unresolvable relative paths.
- README.md: Require authenticated gh CLI (gh auth login) in the
  quick-setup prerequisites.

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix broken links in workflow documentation Fix docs build strict-mode failure and add missing gh auth prerequisite Feb 21, 2026
Copilot AI requested a review from strawgate February 21, 2026 15:25
@strawgate strawgate marked this pull request as ready for review February 21, 2026 16:03
@strawgate
Copy link
Collaborator

/ai address feedback please

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions
Copy link
Contributor

Addressed the feedback and pushed a follow-up commit.

  • Fixed the README prerequisite sentence to use plain parenthetical text instead of an unresolved markdown reference link:
    • README.md:24
  • Resolved the corresponding review thread.

Validation run:

  • make docs-build (with UV_CACHE_DIR=/tmp/gh-aw/agent/uv-cache and a local venv uv on PATH) ✅

What is this? | From workflow: Mention in PR

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

@strawgate strawgate merged commit 75208f4 into main Feb 21, 2026
1 check passed
@strawgate strawgate deleted the copilot/fix-workflow-docs-links branch February 21, 2026 16:43
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.

[newbie-contributor] New contributor docs review — broken workflow docs links and missing quick-setup auth prerequisite

2 participants