-
Notifications
You must be signed in to change notification settings - Fork 45
Closed
5 / 55 of 5 issues completedClosed
5 / 55 of 5 issues completed
Copy link
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplanuser-experience
Description
Overview
This tracking issue addresses critical documentation gaps and confusing areas identified in the December 15, 2025 noob test report. The goal is to significantly improve the new user experience by clarifying concepts, adding prerequisites, and simplifying examples.
Source: Discussion #6502
Priority Focus
The noob test identified several blocking issues that prevent complete beginners from successfully getting started:
- Missing "What is this?" context - Users don't understand what gh-aw actually is
- Unclear prerequisites - Users don't know what they need before starting
- Complex first example - The initial workflow is too overwhelming
- Undefined jargon - Terms like "agentic", "frontmatter", and "YAML" used without explanation
Planned Tasks
This work is broken down into 5 focused sub-issues that can be completed independently:
- Add "What is GitHub Agentic Workflows?" section to homepage
- Add comprehensive prerequisites section to Quick Start guide
- Create simpler "Hello World" first workflow example
- Add glossary definitions for technical jargon
- Improve "Safe Outputs" explanation and add verification steps
Success Criteria
- New users understand what gh-aw is before reading further
- Prerequisites are clear and checkable before installation
- First workflow example is simple enough for complete beginners
- Technical terms are defined on first use
- Users can verify their setup is working correctly
Related
- Discussion: 📚 Documentation Noob Test Report - December 15, 2025 #6502 (Documentation Noob Test Report)
- Labels: documentation, user-experience
AI generated by Plan Command for discussion #6502
Reactions are currently unavailable
Sub-issues
Metadata
Metadata
Assignees
Labels
ai-generateddocumentationImprovements or additions to documentationImprovements or additions to documentationplanuser-experience