Skip to content

[task] Define jargon terms on first use throughout documentation #4260

@github-actions

Description

@github-actions

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions