Clarify lock files and workflow setup commands in docs - #54342
Merged
Conversation
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add side-by-side .lock.yml example to Quick Start and clarify CLI commands
Clarify lock files and workflow setup commands in docs
Aug 20, 2026
pelikhan
marked this pull request as ready for review
August 20, 2026 21:06
Contributor
There was a problem hiding this comment.
Pull request overview
Clarifies generated workflow lock files and setup command selection for new users.
Changes:
- Adds a Markdown-to-compiled-YAML example.
- Adds a setup command comparison table.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/setup/quick-start.mdx |
Demonstrates source and compiled workflow structure. |
docs/src/content/docs/setup/cli.md |
Compares workflow setup commands. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 2
- Review effort level: Balanced
Comment on lines
+171
to
+173
| permissions: | ||
| contents: read | ||
| issues: read |
Comment on lines
+147
to
+153
| Use this table to choose between the similarly named setup commands: | ||
|
|
||
| | Command | Best fit | | ||
| |---------|----------| | ||
| | [`gh aw add-wizard`](#add-wizard) | Guided, interactive setup for an existing workflow, including prompts for engine auth and secrets | | ||
| | [`gh aw add`](#add) | Direct, non-interactive installation of an existing local, remote, or packaged workflow | | ||
| | [`gh aw new`](#new) | Scaffold a new workflow template in this repository before writing custom instructions | |
Contributor
|
🎉 This pull request is included in a new release. Release: |
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.
The onboarding docs described generated
.lock.ymlfiles without showing how Markdown source maps to compiled workflow YAML. The CLI reference also listedadd-wizard,add, andnewclose together without a quick chooser for first-time users..mdsource and.lock.ymlexcerpt.gh-awmoves source-level permissions onto generated jobs.add-wizard: guided interactive setupadd: direct/non-interactive installationnew: scaffold a fresh workflow