-
Notifications
You must be signed in to change notification settings - Fork 46
Closed
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan
Description
Objective
Replace the complex "daily team status" workflow with a simple "Hello World" example that introduces concepts gradually without overwhelming beginners.
Problem
The current first workflow example includes:
- Cron schedule triggers
- Multiple permission types
- GitHub MCP tools
- Safe outputs configuration
This is too much for a complete beginner to understand all at once.
Approach
- Create a new simple example workflow in the Quick Start guide:
---
on:
workflow_dispatch: # Manual trigger only
permissions:
contents: read
engine: copilot
safe-outputs:
create-discussion: {}
---
# My First Agentic Workflow
Create a discussion in the "General" category that says "Hello from my first agentic workflow!"
Include today's date and a fun fact about GitHub Copilot.-
Move the complex daily team status example to a separate "Examples" page or later in the guide
-
Add explanatory comments about what each part does
Files to Modify
docs/src/content/docs/setup/quick-start.mdx- Replace first example with simpler version- Optionally:
docs/src/content/docs/examples/- Move complex example to examples section
Acceptance Criteria
- First example uses only
workflow_dispatch(manual trigger) - Includes minimal configuration options
- Has inline comments explaining each section
- Produces a visible, simple result (creates a discussion)
- Can be completed without understanding cron syntax or GitHub MCP
- More complex example moved to later in guide or examples section
Reference
From noob test report: "Example Workflow Too Complex for 'First Workflow'" - Confusing Area #6
Related to #6505
AI generated by Plan Command for discussion #6502
Copilot
Metadata
Metadata
Assignees
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplan