-
Notifications
You must be signed in to change notification settings - Fork 43
Define jargon terms on first use in documentation #4331
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
- Define "frontmatter" on first use in quick-start.md and how-it-works.mdx - Expand "MCP" acronym and define Model Context Protocol in how-it-works.mdx - Define ".lock.yml" as compiled workflow file in quick-start.md and how-it-works.mdx - Define "safe-outputs" in quick-start.md and overview.mdx - Create comprehensive glossary.md with all technical terms - Documentation builds successfully without errors Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR addresses documentation friction for new users by defining technical jargon terms on first use throughout the documentation. The changes add inline definitions for key concepts like frontmatter, .lock.yml, safe-outputs, and MCP, along with a comprehensive new glossary page.
Key Changes:
- Inline definitions added to Quick Start, How It Works, and Overview pages to explain terms when first encountered
- New glossary reference page created with organized term definitions across 6 domains
- Consistent definition patterns applied across all documentation files
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/src/content/docs/setup/quick-start.md | Added inline definition for .lock.yml and comprehensive explanation of frontmatter, natural language instructions, and safe-outputs |
| docs/src/content/docs/reference/glossary.md | New comprehensive glossary page with 26 term definitions organized by domain (Core Concepts, Tools & Integration, Security & Outputs, Workflow Components, Development & Compilation, Advanced Features) |
| docs/src/content/docs/introduction/overview.mdx | Added inline definition for safe-outputs explaining it as a security feature |
| docs/src/content/docs/introduction/how-it-works.mdx | Added inline definitions for frontmatter (configuration section between markers) and MCP (expanded to Model Context Protocol with explanation) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| This workflow triggers every weekday at 9 AM via cron schedule, has permissions to read repository content and create GitHub discussions, and runs AI instructions in natural language to generate status reports. | ||
|
|
||
| The section between the `---` markers (called frontmatter) contains the YAML configuration that defines when the workflow runs, what permissions it has, and what tools it can use. The section below the frontmatter contains the natural language instructions that tell the AI agent what to do. The `safe-outputs` section specifies that this workflow can safely create GitHub discussions without needing write permissions during the AI execution phase. |
Copilot
AI
Nov 19, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] This paragraph is quite dense and contains three different concept definitions in a single sentence. Consider breaking it into multiple sentences or a bulleted list for better readability:
Suggested revision:
The section between the `---` markers is called **frontmatter**—a YAML configuration section that defines when the workflow runs, what permissions it has, and what tools it can use.
The section below the frontmatter contains the natural language instructions that tell the AI agent what to do.
The `safe-outputs` section specifies that this workflow can safely create GitHub discussions without needing write permissions during the AI execution phase.This improves scannability and makes it easier for new users to absorb each concept individually.
| The section between the `---` markers (called frontmatter) contains the YAML configuration that defines when the workflow runs, what permissions it has, and what tools it can use. The section below the frontmatter contains the natural language instructions that tell the AI agent what to do. The `safe-outputs` section specifies that this workflow can safely create GitHub discussions without needing write permissions during the AI execution phase. | |
| The section between the `---` markers is called **frontmatter**—a YAML configuration section that defines when the workflow runs, what permissions it has, and what tools it can use. |
New users encounter undefined technical terms (frontmatter, MCP, .lock.yml, safe-outputs) before they're explained, creating unnecessary friction.
Changes
Inline definitions added
.lock.yml(compiled GitHub Actions workflow file), explain frontmatter structure and safe-outputs security model---markers), expand MCP to Model Context Protocol with explanation, clarify.lock.ymlcompilationNew glossary reference
Visual Impact
Before: Terms used without context
After: Terms defined inline
Quick Start Page
Glossary Reference
Addresses #4257
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
telemetry.astro.buildnode /home/REDACTED/work/gh-aw/gh-aw/docs/node_modules/.bin/astro build(dns block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.