Skip to content

docs: fix stale deep-research link and add title-prefix input to Gemini workflow READMEs#539

Merged
strawgate merged 2 commits intomainfrom
copilot/update-gh-agent-workflows-docs
Mar 2, 2026
Merged

docs: fix stale deep-research link and add title-prefix input to Gemini workflow READMEs#539
strawgate merged 2 commits intomainfrom
copilot/update-gh-agent-workflows-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 2, 2026

Documentation drift after deep-researchinternal-gemini-cli-web-search rename and addition of title-prefix workflow input.

  • gh-agent-workflows/README.md: Update broken deep-research/ catalog link to internal-gemini-cli-web-search/
  • gh-agent-workflows/internal-gemini-cli/README.md: Add title-prefix input (default: [gemini-cli])
  • gh-agent-workflows/internal-gemini-cli-web-search/README.md: Add title-prefix input (default: [research])

Defaults match the workflow definitions in gh-aw-internal-gemini-cli.md and gh-aw-internal-gemini-cli-web-search.md.

Original prompt

This section details on the original issue you should resolve

<issue_title>[docs-patrol] Update gh-agent-workflows docs for Gemini workflow rename and title-prefix input</issue_title>
<issue_description>Recent code changes in the repository have introduced documentation drift. The following changes need corresponding documentation updates.

Changes Requiring Documentation Updates

1. deep-research link in workflow catalog is stale after rename

Commit(s): d7769a158a38b8ec8868707eb56708a6abeb22bf

What changed:

  • Workflow/docs/examples were renamed from deep-research to internal-gemini-cli-web-search (for example, gh-agent-workflows/deep-research/README.md -> gh-agent-workflows/internal-gemini-cli-web-search/README.md).
  • The old directory no longer exists.

Documentation impact:

  • gh-agent-workflows/README.md still references - [Deep Research](deep-research/) (line 46), which now points to a removed path.
  • Update this catalog entry to the current path/name (internal-gemini-cli-web-search/).

2. New title-prefix input is not documented in Gemini workflow READMEs

Commit(s): da672eddef6168b5c5cc39a9ed89e686c7af4cf5

What changed:

  • Added workflow-call input title-prefix in:
    • .github/workflows/gh-aw-internal-gemini-cli.md
    • .github/workflows/gh-aw-internal-gemini-cli-web-search.md
  • Wired safe output issue title prefix to $\{\{ inputs.title-prefix }} in both workflows.

Documentation impact:

  • gh-agent-workflows/internal-gemini-cli/README.md Inputs table (lines 27-31) does not list title-prefix.
  • gh-agent-workflows/internal-gemini-cli-web-search/README.md Inputs table (lines 27-31) does not list title-prefix.
  • Add title-prefix to both Inputs tables, including default values consistent with workflow definitions.

Suggested Actions

  • Update gh-agent-workflows/README.md to replace the stale deep-research/ link with internal-gemini-cli-web-search/.
  • Add title-prefix input documentation to gh-agent-workflows/internal-gemini-cli/README.md.
  • Add title-prefix input documentation to gh-agent-workflows/internal-gemini-cli-web-search/README.md.

What is this? | From workflow: Docs Patrol

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

  • expires on Mar 9, 2026, 2:32 PM UTC

Comments on the Issue (you are @copilot in this section)


🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

Co-authored-by: strawgate <6384545+strawgate@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for Gemini workflow rename docs: fix stale deep-research link and add title-prefix input to Gemini workflow READMEs Mar 2, 2026
@strawgate strawgate marked this pull request as ready for review March 2, 2026 16:01
@coderabbitai
Copy link

coderabbitai bot commented Mar 2, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b4dc41a and 27a5c07.

📒 Files selected for processing (3)
  • gh-agent-workflows/README.md
  • gh-agent-workflows/internal-gemini-cli-web-search/README.md
  • gh-agent-workflows/internal-gemini-cli/README.md

📝 Walkthrough

Walkthrough

Documentation updates to align with previous code changes: renamed the workflow catalog entry from "Deep Research" to "Internal Gemini CLI Web Search" in the main README, and added documentation for the title-prefix input field in both the internal Gemini CLI and internal Gemini CLI web search workflow READMEs with their respective default values.

Possibly related PRs

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed PR successfully addresses all requirements from issue #535: stale deep-research link replaced with internal-gemini-cli-web-search, and title-prefix input documented in both Gemini workflow READMEs with correct defaults.
Out of Scope Changes check ✅ Passed All changes directly address documentation drift from the linked issue; no out-of-scope modifications detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch copilot/update-gh-agent-workflows-docs

Comment @coderabbitai help to get the list of available commands and usage tips.


**Research assistants**:
- [Deep Research](deep-research/) — issue-comment deep research with web search/fetch and optional PR creation
- [Internal Gemini CLI Web Search](internal-gemini-cli-web-search/) — issue-comment deep research with web search/fetch and optional PR creation
Copy link
Contributor

Choose a reason for hiding this comment

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

[MEDIUM] Catalog description overstates workflow output capability

This entry says the web-search workflow supports "optional PR creation," but the referenced workflow only supports add-comment and create-issue safe outputs. As written, this README can mislead users into expecting PR creation support that does not exist.

Suggested change
- [Internal Gemini CLI Web Search](internal-gemini-cli-web-search/) — issue-comment deep research with web search/fetch and optional PR creation
- [Internal Gemini CLI Web Search](internal-gemini-cli-web-search/) — issue-comment deep research with web search/fetch and optional issue creation

@strawgate strawgate merged commit 486845a into main Mar 2, 2026
18 of 19 checks passed
@strawgate strawgate deleted the copilot/update-gh-agent-workflows-docs branch March 2, 2026 17:23
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.

[docs-patrol] Update gh-agent-workflows docs for Gemini workflow rename and title-prefix input

2 participants