Skip to content

docs: introduce frontmatter reference on first Quick Start path#35092

Closed
Copilot wants to merge 4 commits into
mainfrom
copilot/deep-report-add-inline-definition-glossary-link
Closed

docs: introduce frontmatter reference on first Quick Start path#35092
Copilot wants to merge 4 commits into
mainfrom
copilot/deep-report-add-inline-definition-glossary-link

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 27, 2026

Quick Start first mentioned frontmatter in optional Step 4, so users skipping customization could hit deeper docs without context. This update introduces the term earlier on the default path and links directly to the frontmatter reference.

  • Quick Start content update

    • Added an inline definition + link to frontmatter in the Step 2 flow (before optional customization), in the lock-file explanation block.
    • File: docs/src/content/docs/setup/quick-start.mdx
  • Doc regression coverage

    • Added a focused Playwright spec to assert frontmatter appears before “Step 4 - Customize your workflow”.
    • File: docs/tests/quick-start-frontmatter.spec.ts
Workflow `.md` files start with [frontmatter](/gh-aw/reference/frontmatter/) — the configuration block between the `---` markers at the top of the file.

Copilot AI and others added 2 commits May 27, 2026 01:26
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Co-authored-by: gh-aw-bot <259018956+gh-aw-bot@users.noreply.github.com>
Copilot AI changed the title [WIP] Add inline definition for 'frontmatter' in Quick Start docs docs: introduce frontmatter reference on first Quick Start path May 27, 2026
Copilot AI requested a review from gh-aw-bot May 27, 2026 01:28
@@ -0,0 +1,22 @@
import { test, expect } from '@playwright/test';
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

@copilot revert this file

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in b7b19a1.

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI requested a review from pelikhan May 27, 2026 05:13
@pelikhan pelikhan closed this May 27, 2026
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] Add inline definition / glossary link for "frontmatter" on first use in Quick Start docs

3 participants