Skip to content

[deep-report] Add inline definition / glossary link for "frontmatter" on first use in Quick Start docs #34964

Description

@github-actions

Problem

In the Quick Start guide, the term frontmatter appears for the first time inside Step 4 (Customize) — in an optional step — with only a brief parenthetical: "the configuration block between the --- markers at the top of the file". Beginners who skip Step 4 then encounter the term later in deeper docs with no context.

Evidence

From today's Documentation Noob Test Report (#34871):

The parenthetical definition is helpful, but it's the first time the term appears on the page, and it comes in an optional step — meaning many beginners will encounter frontmatter later in deeper docs with no context. A small tooltip or link to the Glossary/Frontmatter reference would reduce confusion.

Expected impact

Reduces onboarding friction for first-time users.

Suggested agent

doc-healer or delight — small docs change.

Effort

~15 min — add a glossary link on first occurrence in docs/src/content/docs/setup/quick-start.mdx (or equivalent page), referencing the existing frontmatter reference page.


Identified by DeepReport intelligence run on 2026-05-26.

Generated by 🔬 DeepReport - Intelligence Gathering Agent · opus47 11.4M ·

  • expires on May 28, 2026, 4:03 PM UTC

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions