Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Nov 18, 2025

Thanks for assigning this issue to me. I'm starting to work on it and will keep this PR's description up to date as I form a plan and make progress.

Original prompt

This section details on the original issue you should resolve

<issue_title>[task] Define jargon terms on first use throughout documentation</issue_title>
<issue_description>## Objective
Define technical terms when they are first introduced to reduce cognitive load for beginners.

Context

Terms like "frontmatter", "MCP", "trial mode", and "workflow lock" are used before being explained, creating confusion for new users.

Related to #4257 (Documentation Noob Test Report)

Approach

  1. Identify all jargon terms used in Quick Start and Getting Started sections
  2. Add inline definitions or tooltips on first use
  3. Consider adding a glossary page for reference

Files to Modify

  • docs/src/content/docs/setup/quick-start.mdx
  • docs/src/content/docs/concepts/how-it-works.mdx
  • docs/src/content/docs/overview.mdx
  • Consider adding: docs/src/content/docs/reference/glossary.mdx

Key Terms to Define

On first use, add context:

  • frontmatter → "frontmatter (YAML configuration section)"
  • MCP → "MCP (Model Context Protocol)"
  • trial mode → "trial mode (safe preview without making changes)"
  • workflow lock → "workflow lock (.lock.yml compiled output)"

Example Implementation

Before:

The workflow uses frontmatter to configure...

After:

The workflow uses frontmatter (the YAML configuration section between --- markers) to configure...

Or with Astro tooltip component:

The workflow uses (Tooltip text="YAML configuration section between --- markers")frontmatter(/Tooltip) to configure...

Acceptance Criteria

  • "frontmatter" is defined on first use in Quick Start
  • "MCP" acronym is expanded on first use
  • "trial mode" is explained when introduced
  • "workflow lock" is defined when mentioned
  • Documentation builds without errors
  • Consistent pattern for defining terms throughout

Priority

HIGH - Identified as Quick Win #2 with high impact for new users

AI generated by Plan Command for discussion #4257</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@pelikhan pelikhan closed this Nov 18, 2025
Copilot AI requested a review from pelikhan November 18, 2025 08:04
@pelikhan pelikhan deleted the copilot/define-jargon-terms branch December 15, 2025 04:53
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.

[task] Define jargon terms on first use throughout documentation

2 participants