Skip to content

Commit 2ec00ea

Browse files
authored
docs: define frontmatter and demystify jargon in Quick Start (#29352)
1 parent cdd8a6e commit 2ec00ea

1 file changed

Lines changed: 5 additions & 2 deletions

File tree

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

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ This will take you through an interactive process to:
6868
1. **Check prerequisites** - Verify repository permissions.
6969
2. **Select an AI Engine** - Choose between Copilot, Claude, Codex, or Gemini.
7070
3. **Set up the required secret** - [`COPILOT_GITHUB_TOKEN`](/gh-aw/reference/auth/#copilot_github_token) (a separate GitHub token with Copilot access — distinct from the default `GITHUB_TOKEN`), [`ANTHROPIC_API_KEY`](/gh-aw/reference/auth/#anthropic_api_key), [`OPENAI_API_KEY`](/gh-aw/reference/auth/#openai_api_key), or [`GEMINI_API_KEY`](/gh-aw/reference/auth/#gemini_api_key). See [Authentication](/gh-aw/reference/auth/) for setup instructions.
71-
4. **Add the workflow** - Adds the workflow and lock file to `.github/workflows/`.
71+
4. **Add the workflow** - Adds the workflow file (`.md`) and its compiled lock file (`.lock.yml`) to `.github/workflows/`.
7272
5. **Optionally trigger an initial run** - Starts the workflow immediately.
7373

7474
> [!TIP]
@@ -98,11 +98,14 @@ With GitHub Agentic Workflows, you are in control! Your repository automation is
9898

9999
To customize it now:
100100

101+
> [!NOTE]
102+
> Each workflow file has two parts. The **frontmatter** (the configuration block between the `---` markers at the top) controls when the workflow runs, which AI engine powers it, and what tools it can access — changes here require recompiling (step 3). The **body** below contains your natural language task description and instructions — changes here take effect immediately on the next run.
103+
101104
1. Open the workflow markdown file located at `.github/workflows/daily-repo-status.md` in your repository.
102105

103106
2. Edit the section "What to include" to list things you are having trouble with regularly in your repository: your issue blacklog, your CI setup, your testing, the performance of your software, your roadmap. Any or all of these, or anything else you want to improve. You can also customize the style and process sections to guide the coding agent's behavior.
104107

105-
3. If you have changed the [frontmatter](/gh-aw/reference/frontmatter/) (the YAML configuration block between `---` markers at the top of the file), regenerate the workflow YAML by running:
108+
3. If you changed the [frontmatter](/gh-aw/reference/frontmatter/) (the configuration block between the `---` markers at the top of the file), regenerate the compiled workflow by running:
106109

107110
```text
108111
gh aw compile

0 commit comments

Comments
 (0)