Skip to content

Mention gh CLI in the README intro - #14517

Merged
williammartin merged 1 commit into
trunkfrom
bagtoad/readme-seo
Sep 25, 2026
Merged

williammartin merged 1 commit into
trunkfrom
bagtoad/readme-seo

Conversation

@BagToad

@BagToad BagToad commented Sep 25, 2026

Copy link
Copy Markdown
Member

Description

People search for this project as "gh cli", but the phrase never appears on this repository's page. Forks named gh-cli have it in their URLs, so they can outrank this repository for that search.

This adds "gh CLI" to the README's first sentence. It also moves the PGP notice below that sentence, because search engines often use a README's opening text as the result snippet.

How did you test this change?

I rendered the updated README with gh api markdown and saw the heading, the new sentence, the PGP notice, and the screenshot, in that order.

I did not test the effect on search results. That needs this change on trunk and a recrawl.

Key points

  • "gh CLI" is plain text, not code-formatted, so it matches what people type.
  • The PGP notice moved but was not removed.

Notes for reviewers

N/A

Authorship and follow-up

Who wrote this:

  • A human wrote it.
  • An agent wrote it under close human direction.
  • An agent wrote it independently, and no human has guided the implementation beyond the initial prompt.

Who answers review comments:

  • @BagToad will read and reply directly.
  • An agent will draft replies and @username will read them before they are posted.
  • Nobody has explicitly committed to replying.

Move the PGP notice below the intro so the README opens with the project description.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
@BagToad
BagToad requested a review from a team as a code owner September 25, 2026 00:28
@BagToad
BagToad requested review from babakks and a balanced review from Copilot September 25, 2026 00:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot review overview

🟢 Approval recommended

The focused documentation change matches the stated intent and renders correctly.

Review effort: Balanced
Findings: None

What changed in this PR

Updates the README introduction to improve discovery for “gh CLI” searches.

Changes:

  • Adds “gh CLI” to the opening sentence.
  • Moves the PGP notice below the introduction.
File Description
README.md Revises and reorders introductory content.

💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@williammartin
williammartin merged commit babd691 into trunk Sep 25, 2026
14 checks passed
@williammartin
williammartin deleted the bagtoad/readme-seo branch September 25, 2026 06:41
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.

3 participants