Documentation improvements from beginner user testing#5802
Merged
Conversation
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
- Add "What are Agentic Workflows?" section to home page explaining core concepts - Improve Quick Start prerequisites with "why needed" explanations - Move compilation explanation earlier and improve clarity - Enhance Step 3 PAT creation with detailed step-by-step guidance - Add inline glossary definitions for technical terms - Enhance glossary with "agentic" definition and clearer explanations Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Improve documentation based on beginner user testing feedback
Documentation improvements from beginner user testing
Dec 8, 2025
pelikhan
approved these changes
Dec 8, 2025
This was referenced Dec 8, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User testing revealed three critical barriers for new users: undefined "agentic" terminology, late introduction of compilation concepts, and missing rationale for prerequisites.
Changes
Home page (index.mdx)
Quick Start (quick-start.md)
.md→gh aw compile→.lock.ymlGlossary (glossary.md)
Introduction pages
Before:
After:
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/opt/hostedtoolcache/node/24.11.1/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
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.