Skip to content

Clarify Quick Start terminology for frontmatter and .lock.yml#44079

Merged
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-docs-frontmatter-lock-yml
Jul 7, 2026
Merged

Clarify Quick Start terminology for frontmatter and .lock.yml#44079
pelikhan merged 2 commits into
mainfrom
copilot/deep-report-docs-frontmatter-lock-yml

Conversation

Copilot AI commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Quick Start used two terms without defining them on first use: frontmatter and .lock.yml. This tightens the onboarding copy so beginners can understand the file structure and generated workflow artifacts without leaving the page.

  • Quick Start wording

    • Defines frontmatter inline as the settings block between the --- lines.
    • Defines .lock.yml inline in Step 2 as the compiled workflow that GitHub Actions runs.
  • Scope

    • Limits the change to the first-use explanations in docs/src/content/docs/setup/quick-start.mdx.
    • Keeps the existing flow and deeper reference links unchanged.

Example of the updated clarification:

> Note: if `engine:` is later removed manually from the workflow frontmatter
> (the settings block at the top of the file, between the `---` lines),
> the runtime defaults to Copilot.

4. **Add the workflow** - Adds the workflow file (`.md`) and its generated
GitHub Actions lock file (`.lock.yml`, the compiled workflow that GitHub Actions
actually runs) to `.github/workflows/`.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add definitions for frontmatter and .lock.yml in Quick Start Clarify Quick Start terminology for frontmatter and .lock.yml Jul 7, 2026
Copilot AI requested a review from pelikhan July 7, 2026 16:51
@pelikhan pelikhan marked this pull request as ready for review July 7, 2026 16:53
Copilot AI review requested due to automatic review settings July 7, 2026 16:53
@pelikhan pelikhan merged commit 15260ac into main Jul 7, 2026
1 check passed
@pelikhan pelikhan deleted the copilot/deep-report-docs-frontmatter-lock-yml branch July 7, 2026 16:54

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Quick Start documentation to define “frontmatter” and “.lock.yml” inline on first mention, improving onboarding clarity for new users reading the gh aw setup guide.

Changes:

  • Clarifies “frontmatter” as the settings block between the --- lines at the top of the workflow file.
  • Clarifies “.lock.yml” as the compiled GitHub Actions workflow that actually runs.
Show a summary per file
File Description
docs/src/content/docs/setup/quick-start.mdx Adds first-use definitions for frontmatter and .lock.yml within the Quick Start flow.

Review details

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

  • Files reviewed: 1/1 changed files
  • Comments generated: 0
  • Review effort level: Low

@github-actions

github-actions Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

🎉 This pull request is included in a new release.

Release: v0.82.4

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.

[deep-report] Docs: define "frontmatter" and .lock.yml on first use in Quick Start

3 participants