Skip to content

docs: consolidate prerequisites section with verification commands #6559

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pelikhan merged 3 commits into from
Dec 15, 2025
Merged

docs: consolidate prerequisites section with verification commands #6559

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed65212
Initial plan
Copilot Dec 15, 2025
68de622
Initial plan: Enhance prerequisites section in Quick Start guide
Copilot Dec 15, 2025
d23bb35
docs: enhance prerequisites section in Quick Start guide
Copilot Dec 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/go-file-size-reduction.campaign.g.md
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

51 changes: 25 additions & 26 deletions docs/src/content/docs/setup/quick-start.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,40 @@ sidebar:

## Prerequisites

This guide walks you through setup step-by-step, so you don't need everything upfront. Here's what you need at each stage and **why**:
Before installing, ensure you have:

:::note[Must Have (before you start)]

- **GitHub account** with access to a repository
- ✅ **[GitHub CLI](https://cli.github.com/)** installed and authenticated
- *Why:* Required to compile workflows and deploy them to your repository
- *How to verify:* Run `gh --version` (requires v2.0.0 or higher) and `gh auth login` to authenticate
- ✅ **GitHub account** with access to a repository (personal or organization)
- *Why:* Agentic workflows run as GitHub Actions in your repositories
- **GitHub CLI (gh)** installed and authenticated ([installation guide](https://cli.github.com))
- *Why:* The CLI is required to compile workflows and deploy them to your repository
- Verify installation: Run `gh --version` (requires v2.0.0 or higher)
- Verify authentication: Run `gh auth status`
- **Operating System:** Linux, macOS, or Windows with WSL
- *Why:* The CLI tools and workflow compilation require a Unix-like environment

:::

:::tip[Must Configure (in your repository)]

- **Admin or write access** to your target repository
- ✅ **Admin or write access** to your target repository
- *Why:* You need permission to add workflows, enable Actions, and configure secrets
- **GitHub Actions** enabled
- ✅ **GitHub Actions** enabled in your repository
- *Why:* Agentic workflows compile to GitHub Actions YAML files that run on GitHub's infrastructure
- **Discussions** enabled (optional for custom workflows)
- *Why:* The example workflow in this guide creates a daily status report as a discussion post
- *Note:* You can disable this requirement by customizing the workflow to use different outputs
- ✅ **Git** installed on your machine
- *Why:* Used to manage repository files and push workflow changes
- ✅ **Operating System:** Linux, macOS, or Windows with WSL
- *Why:* The CLI tools and workflow compilation require a Unix-like environment

:::tip[Optional: Enable Discussions]
The example workflow in this guide creates a daily status report as a **GitHub Discussion** post. To use this example as-is, enable Discussions in your repository settings. Otherwise, you can customize the workflow to use different outputs (like issues or comments).
:::

:::caution[Will Need Later (you'll set this up in Step 3)]
**Verify your setup:**

- **Personal Access Token (PAT)** with Copilot Requests permission ([PAT documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens))
- *Why:* This token authenticates your workflows to use GitHub Copilot as the AI agent that executes your natural language instructions
- *Note:* "Copilot Requests" is a new permission type added in 2024 that allows workflows to communicate with GitHub Copilot's AI services
- *Important:* If you don't see this permission, ensure your GitHub account has Copilot access
- The guide walks you through creating this token in Step 3
```bash
gh --version # Should show version 2.0.0 or higher
gh auth status # Should show "Logged in to github.com"
git --version # Should show git version 2.x or higher
```

:::caution[You'll need later (Step 3)]
**Personal Access Token (PAT)** with Copilot Requests permission ([create token](https://github.com/settings/personal-access-tokens/new))
- *Why:* This token authenticates your workflows to use [GitHub Copilot](https://github.com/features/copilot) as the AI agent that executes your natural language instructions
- *Note:* "Copilot Requests" is a new permission type that allows workflows to communicate with GitHub Copilot's AI services
- *Important:* Requires an active GitHub Copilot subscription
- The guide walks you through creating this token in Step 3
:::

### Agentic Setup
Expand Down