Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Jan 28, 2026

Claude users needed a complete quick-start example with frontmatter, workflow code, and deployment steps in a single copy-pasteable section.

Changes

  • Updated Claude example structure: Changed from explanatory format to numbered step-by-step instructions (1. Create, 2. Set up, 3. Compile, 4. Test)
  • Simplified workflow trigger: on: issues instead of on: issues: types: [opened]
  • Updated permissions: Changed issues: read to issues: write (required for commenting)
  • Renamed workflow: issue-triage.md instead of issue-analyzer.md
  • Updated prompt: Focus on triage (identify type, check completeness, suggest labels) vs. analysis

Before:

### Quick Example with Claude

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

**File**: `.github/workflows/issue-analyzer.md`
...
**Setup:**
1. Get your API key from [Anthropic Console]...

After:

### Quick Example: Issue Triage with Claude

Here's a complete example to get started with Claude:

**1. Create `.github/workflows/issue-triage.md`:**
...
**4. Test it:** Open a new issue in your repository - Claude will automatically analyze and comment!

Location: docs/src/content/docs/reference/engines.md lines 79-121

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: /opt/hostedtoolcache/node/24.13.0/x64/bin/node node /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build (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>[plan] Add 'Getting Started with Claude' example to engines.md</issue_title>
<issue_description>## Context

As identified in discussion #12027, the engines documentation lacks a complete quick-start example for Claude users. While Claude setup instructions exist, there's no end-to-end "hello world" workflow to demonstrate the complete experience.

Problem

  • Claude users need to piece together information from multiple sections
  • No single example showing: frontmatter + workflow code + authentication setup
  • Missing a "success path" that users can copy-paste and run immediately
  • Documentation shows detailed explanations but lacks practical quick-start

Objective

Add a complete, minimal Claude workflow example that users can copy-paste and run successfully within minutes.

Proposed Solution

Add after the Claude Setup section in docs/src/content/docs/reference/engines.md:

### Quick Example: Issue Triage with Claude

Here's a complete example to get started with Claude:

**1. Create `.github/workflows/issue-triage.md`:**

```markdown
---
engine: claude
on: issues
permissions:
  contents: read
  issues: write
safe-outputs:
  add-comment:
---

# Issue Triage

Analyze this issue and provide helpful triage suggestions:

1. Identify the issue type (bug, feature request, question, etc.)
2. Check if the issue has enough information
3. Suggest appropriate labels
4. Provide a helpful response
```

**2. Set up your Anthropic API key:**

```bash
gh aw secrets set ANTHROPIC_API_KEY --value "sk-ant-..."
```

**3. Compile and push the workflow:**

```bash
gh aw compile .github/workflows/issue-triage.md
git add .github/workflows/issue-triage.lock.yml
git commit -m "Add Claude-powered issue triage workflow"
git push
```

**4. Test it:** Open a new issue in your repository - Claude will automatically analyze and comment!

Files to Modify

  • docs/src/content/docs/reference/engines.md (add after Claude Setup section, around line 77)

Acceptance Criteria

  • Add complete quick-start example with all steps
  • Include frontmatter configuration
  • Include workflow markdown content
  • Include authentication setup command
  • Include compilation and deployment steps
  • Include testing instructions
  • Verify example is copy-pasteable and works as-is
  • Example should be runnable within 5 minutes

Testing

Verify the example works:

  1. Follow the steps exactly as written
  2. Ensure the workflow compiles without errors
  3. Ensure the workflow triggers on a test issue
  4. Ensure Claude processes and responds successfully

References

AI generated by Plan Command for discussion #12027

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.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add getting started example for Claude in engines.md Add Quick Example: Issue Triage with Claude to engines.md Jan 28, 2026
@pelikhan pelikhan closed this Jan 28, 2026
Copilot AI requested a review from pelikhan January 28, 2026 01:38
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 'Getting Started with Claude' example to engines.md

2 participants