Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 27, 2026

Claude documentation lacked a concrete workflow example. Users had to infer usage patterns from Copilot-focused examples.

Changes

  • Added "Quick Example with Claude" section to docs/src/content/docs/reference/engines.md
  • Provides complete issue analysis workflow demonstrating Claude's reasoning capabilities
  • Includes API key setup, compilation steps, and safe-outputs configuration

Example Added

The workflow triggers on new issues and posts an analysis comment:

---
engine: claude
on: 
  issues:
    types: [opened]
permissions:
  contents: read
  issues: read
safe-outputs:
  add-comment:
---

# Issue Analysis

Analyze this issue and provide:
1. Summary of the problem
2. Suggested labels
3. Any immediate concerns

Setup instructions walk through API key configuration and deployment using gh aw compile.

Screenshot

Claude Example Documentation

The example uses issues: read (not write) per strict-mode requirements, with safe-outputs handling the comment operation.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • telemetry.astro.build
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build u/13/cc1 /hom�� ux-amd64/src/net-p /tree/enumeratorgolang.org/x/crypto/nacl/box 0.1-go1.25.0.lin-lang=go1.24 -o public/slides/in/usr/bin/lesspipe (dns block)
    • Triggering command: /usr/local/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro dev o_main.o swit�� /index.html m rg/toolchain@v0.0.1-go1.25.0.lin-lang=go1.25 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>[Code Quality] Add "Getting Started with Claude" quick example to documentation</issue_title>
<issue_description>## Description

Claude users need a complete, minimal workflow example to quickly understand how to use Claude with gh-aw. Currently, the documentation focuses on Copilot examples, leaving Claude users to infer how things work.

Affected File

docs/src/content/docs/reference/engines.md

Current Gap

The Claude Setup section explains configuration but lacks a concrete "hello world" example showing:

  • Complete workflow file structure
  • Required frontmatter
  • API key setup command
  • What the workflow actually does

Suggested Addition

Add after the "Claude Setup" section:

### Quick Example with Claude

Here's a minimal workflow that uses Claude to analyze GitHub issues:

**File**: `.github/workflows/issue-analyzer.md`

``````yaml
---
engine: claude
on: 
  issues:
    types: [opened]
permissions:
  contents: read
  issues: write
safe-outputs:
  add-comment:
---

# Issue Analysis

Analyze this issue and provide:
1. Summary of the problem
2. Suggested labels
3. Any immediate concerns

Setup:

  1. Get your API key from [Anthropic Console]((redacted)
  2. Set the secret:
    gh aw secrets set ANTHROPIC_API_KEY --value "(your-anthropic-api-key)"
  3. Compile and run:
    gh aw compile issue-analyzer.md
    git add .github/workflows/issue-analyzer.lock.yml
    git commit -m "Add issue analyzer workflow"
    git push

What it does:

  • Triggers on new issues
  • Claude analyzes the issue content
  • Posts a comment with analysis
  • Uses same safe-outputs system as all engines

## Impact

**Severity**: Medium  
**Audience**: New Claude users  
**Benefit**:
- Reduces time-to-first-workflow
- Shows Claude is a first-class option
- Provides copy-paste starting point

## Success Criteria

- [ ] Complete workflow example added to `engines.md`
- [ ] Example includes all required frontmatter
- [ ] Setup steps clearly documented
- [ ] Example is tested and works
- [ ] Documentation builds successfully

## Source

Extracted from [Claude Code User Documentation Review discussion githubnext/gh-aw#12027](https://github.com/githubnext/gh-aw/discussions/12027)

**Finding**: Priority 2 - Add "Getting Started with Claude" quick example  
**Priority**: Medium  
**Effort**: Low

## Notes

- Example should be minimal but complete (not "hello world" but a real use case)
- Should demonstrate Claude-specific strengths (reasoning, analysis)
- Should work without modification if user follows setup steps
- Consider adding similar examples for Codex later


<!-- gh-aw-tracker-id: discussion-task-miner -->




> AI generated by [Discussion Task Miner - Code Quality Improvement Agent](https://github.com/githubnext/gh-aw/actions/runs/21413996494)
> - [x] expires <!-- gh-aw-expires: 2026-02-10T21:06:25.795Z --> on Feb 10, 2026, 9:06 PM UTC

<!-- gh-aw-agentic-workflow: Discussion Task Miner - Code Quality Improvement Agent, gh-aw-tracker-id: discussion-task-miner, engine: copilot, run: https://github.com/githubnext/gh-aw/actions/runs/21413996494 -->

<!-- gh-aw-workflow-id: discussion-task-miner --></issue_description>

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

<comments>
</comments>


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add quick example for using Claude in documentation Add Claude quick-start workflow example to engines documentation Jan 27, 2026
Copilot AI requested a review from pelikhan January 27, 2026 22:04
@pelikhan pelikhan marked this pull request as ready for review January 27, 2026 22:05
@pelikhan pelikhan merged commit 492ce76 into main Jan 27, 2026
@pelikhan pelikhan deleted the copilot/add-quick-example-claude branch January 27, 2026 22:06
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.

[Code Quality] Add "Getting Started with Claude" quick example to documentation

2 participants