Skip to content

docs: add GitHub CLI explanation to prerequisites#7930

Merged
pelikhan merged 2 commits intomainfrom
copilot/add-github-cli-explanation
Dec 28, 2025
Merged

docs: add GitHub CLI explanation to prerequisites#7930
pelikhan merged 2 commits intomainfrom
copilot/add-github-cli-explanation

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

The prerequisites section assumed familiarity with GitHub CLI, which absolute beginners may not have.

Changes

  • Prerequisites section (docs/src/content/docs/setup/quick-start.md)
    • Added command name (gh) for immediate recognition
    • Explained GitHub CLI as "a command-line tool for GitHub operations"
    • Clarified installation link with "Install here" call-to-action
    • Preserved version and authentication requirements

Before:

-**[GitHub CLI](https://cli.github.com/)** v2.0.0+ installed and authenticated (`gh auth login`)

After:

-**GitHub CLI** (`gh`) - A command-line tool for GitHub operations. [Install here](https://cli.github.com) v2.0.0+ and authenticate with `gh auth login`

Helps beginners understand what GitHub CLI is and where to get it without hunting through documentation.

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add GitHub CLI explanation to prerequisites section</issue_title>
<issue_description>## Objective

Add a brief explanation of what the GitHub CLI is in the prerequisites section to help absolute beginners.

Context

The documentation assumes users know what "GitHub CLI" is, but absolute beginners may not understand it's a command-line tool or where to get it.

Implementation

In the prerequisites section, change:

Before:

**GitHub CLI** - Required for installation

After:

**GitHub CLI** (`gh`) - A command-line tool for GitHub operations. [Install here](https://cli.github.com)

Files to Update

  • docs/src/content/docs/guides/quick-start.md (prerequisites section)
  • Any other pages that list prerequisites

Acceptance Criteria

  • GitHub CLI is explained as a "command-line tool"
  • Link to installation page (https://cli.github.com) included
  • Command name (gh) is mentioned
  • Explanation is concise (one sentence)

AI generated by Plan Command for discussion #7874

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


💡 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.

- Add brief explanation of GitHub CLI as a command-line tool
- Include command name (gh) for clarity
- Add direct link to installation page
- Keep version and authentication requirements

Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub CLI explanation to prerequisites section docs: add GitHub CLI explanation to prerequisites Dec 27, 2025
Copilot AI requested a review from mnkiefer December 27, 2025 22:00
@pelikhan pelikhan marked this pull request as ready for review December 28, 2025 01:57
@pelikhan pelikhan merged commit 65bc457 into main Dec 28, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/add-github-cli-explanation branch December 28, 2025 01:57
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.

[plan] Add GitHub CLI explanation to prerequisites section

3 participants