Skip to content

Move compilation explanation before command in Quick Start#4504

Closed
Copilot wants to merge 2 commits intomainfrom
copilot/reorder-quick-start-guide
Closed

Move compilation explanation before command in Quick Start#4504
Copilot wants to merge 2 commits intomainfrom
copilot/reorder-quick-start-guide

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Nov 21, 2025

Users were executing gh aw add before understanding why they'd see two files (.md and .lock.yml) in the PR, causing mid-flow confusion.

Changes

Reordered Step 2 to explain compilation concept before command execution:

  • Added "Understanding the files" subsection explaining the two-file system upfront
  • Moved compilation explanation from after command to before it
  • Added translation analogy: "Think of compilation like translating: Markdown → YAML"
  • Updated command description to reference "both files" now that they're pre-explained

Before/After Flow

Before:

### Step 2
Run command → See two files in PR → "Why two files?" explanation

After:

### Step 2
Explanation: two files (.md + .lock.yml) → Clear analogy → Run command

Users now understand what they'll see before they see it.

Fixes #4468

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.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

This section details on the original issue you should resolve

<issue_title>[task] Move "Why Compile?" explanation before compilation command in Quick Start</issue_title>
<issue_description>## Objective
Reorder the Quick Start guide to explain the compilation concept BEFORE users run the command, preventing mid-flow confusion.

Context

Currently in Step 2, users execute gh aw add which creates a .lock.yml file, but the "Why Compile?" explanation comes after. This causes confusion when users see the PR with two files. Part of discussion #4466.

Approach

  1. Move the "Why Compile?" section to appear BEFORE the gh aw add command
  2. Add clear analogy: "Think of compilation like translating: Markdown → YAML"
  3. Explain the two-file system upfront
  4. Keep the technical details in the existing explanation

Suggested Structure

### Step 2 — Add a sample workflow

**Understanding the files:** Agentic workflows use two files:
- `.md` file - What you write (human-friendly markdown)
- `.lock.yml` file - What GitHub Actions runs (auto-generated)

Think of compilation like translating: Markdown → YAML

Now let's add a sample workflow...

[Command follows here]

Files to Modify

  • docs/src/content/docs/setup/quick-start.mdx

Acceptance Criteria

  • "Why Compile?" explanation appears before the command
  • Two-file system explained clearly
  • Analogy helps non-technical users understand
  • Flow reads naturally without jumping around
  • No duplicate content created

Estimated Impact

AI generated by Plan Command for discussion #4466</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…tart

Reordered Step 2 to explain the two-file system and compilation concept
BEFORE users execute the `gh aw add` command. This prevents confusion when
users see the PR with two files (.md and .lock.yml).

Changes:
- Added "Understanding the files" subsection at the start of Step 2
- Explained two-file system (.md and .lock.yml) upfront
- Added clear analogy: "Think of compilation like translating: Markdown → YAML"
- Moved compilation explanation before the command execution
- Kept technical details intact while improving the flow
- Updated command description to mention "both" files

The documentation builds successfully with no errors.

Fixes #4468

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Move 'Why Compile?' explanation before compilation command Move compilation explanation before command in Quick Start Nov 21, 2025
Copilot AI requested a review from pelikhan November 21, 2025 18:04
@pelikhan pelikhan closed this Nov 21, 2025
@pelikhan pelikhan deleted the copilot/reorder-quick-start-guide branch November 22, 2025 06:16
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.

[task] Move "Why Compile?" explanation before compilation command in Quick Start

2 participants