Skip to content

Comments

Add inline definitions for domain-specific terms in documentation#7933

Merged
pelikhan merged 3 commits intomainfrom
copilot/add-inline-definitions
Dec 28, 2025
Merged

Add inline definitions for domain-specific terms in documentation#7933
pelikhan merged 3 commits intomainfrom
copilot/add-inline-definitions

Conversation

Copy link
Contributor

Copilot AI commented Dec 27, 2025

Beginner testing revealed users must frequently navigate away from documentation to understand basic concepts like "frontmatter", "MCP", "safe-inputs", "safe-outputs", "engine", and "toolsets".

Changes

Added parenthetical inline definitions on first use of technical terms using pattern [term](/glossary/#term) (brief definition):

Terms defined:

  • Frontmatter → YAML configuration section (3 words)
  • MCP → Model Context Protocol, standard for AI tool integration (9 words)
  • Safe-inputs → validated user input tools (4 words)
  • Safe-outputs → validated GitHub operations (3 words)
  • Engine → AI model/provider (2 words)
  • Toolsets → capability collections (2 words)

Files updated (13 total):

  • Getting-started: quick-start.md, agentic-authoring.mdx, how-it-works.mdx, overview.mdx
  • Guides: mcps.md
  • Reference: frontmatter.md, safe-inputs.md, safe-outputs.md, engines.md, tools.md
  • Examples: issueops.md, dailyops.md, chatops.md

Example

Before:

The frontmatter section of GitHub Agentic Workflows includes the triggers...

After:

The [frontmatter](/gh-aw/reference/glossary/#frontmatter) (YAML configuration section) 
of GitHub Agentic Workflows includes the triggers...

All definitions remain under 10 words. Glossary links preserved for detailed explanations.

Original prompt

This section details on the original issue you should resolve

<issue_title>[plan] Add inline definitions for domain-specific terms throughout documentation</issue_title>
<issue_description>## Objective

Add inline definitions or tooltips for domain-specific jargon on first use to reduce cognitive load and context-switching for beginners.

Context

Beginner testing revealed that users must frequently navigate to reference documentation to understand basic concepts like "frontmatter", "MCP", "safe-inputs", "safe-outputs", "engine", and "toolsets".

Terms to Define

Add brief inline definitions for these terms on first use:

  1. Frontmatter - The YAML metadata section at the top of workflow files
  2. MCP - Model Context Protocol (expand acronym, explain it's for AI tool integration)
  3. Safe-inputs - Validated user input to prevent injection attacks
  4. Safe-outputs - Validated GitHub API operations
  5. Engine - The AI model/provider (Copilot, Claude, etc.)
  6. Toolsets - Collections of capabilities provided to the AI agent

Approach

For each term, add a brief parenthetical definition on first use:

The frontmatter (YAML metadata section) contains configuration...
Configure the MCP (Model Context Protocol) server for tool integration...
Safe-inputs (validated user input) prevent injection attacks...

Files to Update

Search for first use of each term in:

  • docs/src/content/docs/guides/quick-start.md
  • docs/src/content/docs/guides/agentic-authoring.mdx
  • docs/src/content/docs/examples/*.md
  • Other getting-started pages

Acceptance Criteria

  • Each term has an inline definition on first use
  • Definitions are concise (under 10 words)
  • Links to full glossary entries remain for deeper explanation
  • Beginners can understand concepts without leaving the page

AI generated by Plan Command for discussion #7874

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.

Copilot AI and others added 2 commits December 27, 2025 23:03
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com>
Copilot AI changed the title [WIP] Add inline definitions for domain-specific terms in documentation Add inline definitions for domain-specific terms in documentation Dec 27, 2025
Copilot AI requested a review from mnkiefer December 27, 2025 23:09
@pelikhan pelikhan marked this pull request as ready for review December 28, 2025 01:58
@pelikhan pelikhan merged commit 0c2cb06 into main Dec 28, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/add-inline-definitions branch December 28, 2025 01:58
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.

[plan] Add inline definitions for domain-specific terms throughout documentation

3 participants