Skip to content

[plan] Improve documentation for new users based on noob test feedback #6505

@github-actions

Description

@github-actions

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:

  1. Missing "What is this?" context - Users don't understand what gh-aw actually is
  2. Unclear prerequisites - Users don't know what they need before starting
  3. Complex first example - The initial workflow is too overwhelming
  4. 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:

  1. Add "What is GitHub Agentic Workflows?" section to homepage
  2. Add comprehensive prerequisites section to Quick Start guide
  3. Create simpler "Hello World" first workflow example
  4. Add glossary definitions for technical jargon
  5. 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

AI generated by Plan Command for discussion #6502

Sub-issues

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions