docs: define frontmatter and demystify jargon in Quick Start#29352
Merged
Conversation
… before first use Agent-Logs-Url: https://github.com/github/gh-aw/sessions/df227c85-9d31-4166-9228-97b968299655 Co-authored-by: gh-aw-bot <[email protected]>
Copilot
AI
changed the title
[WIP] Fix Quick Start documentation to explain 'frontmatter' and terms
docs: define frontmatter and demystify jargon in Quick Start
Apr 30, 2026
pelikhan
approved these changes
Apr 30, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the Quick Start guide to define “frontmatter” before it’s used and to reduce unexplained jargon during workflow customization.
Changes:
- Added a Step 4 NOTE explaining frontmatter vs. body and when recompilation is required.
- Removed “YAML” terminology in Step 4 item 3 and reframed the instruction around recompiling the workflow.
- Clarified “lock file” in Step 2 item 4 by naming the
.mdsource and.lock.ymlcompiled output.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/setup/quick-start.mdx | Adds frontmatter definition and clarifies workflow/lock-file terminology in the Quick Start. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 1
|
|
||
| 1. Open the workflow markdown file located at `.github/workflows/daily-repo-status.md` in your repository. | ||
|
|
||
| 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. |
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 Quick Start guide introduced "frontmatter" (and "YAML") in Step 4 without prior definition — a documented blocker for new users reaching the customization step.
Changes
Step 4 — new NOTE callout: defines
frontmatter(configuration between---markers) vs. thebody(natural language instructions), and clarifies which requires recompiling and which doesn't — placed before the numbered list so users have context before hitting item 3Step 4, item 3: removed "YAML" from both the description ("YAML configuration block" → "configuration block") and the instruction ("regenerate the workflow YAML" → "regenerate the compiled workflow")
Step 2, item 4: expanded "lock file" to "workflow file (
.md) and its compiled lock file (.lock.yml)" — the term appeared without explanation