From 23a828397b864fe4b341a1daf14aa5cd1898818c Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Dec 2025 12:19:35 +0000 Subject: [PATCH 1/3] Initial plan From 361f8269e9486a00e390c7c48df181fe3fcde482 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Dec 2025 12:23:45 +0000 Subject: [PATCH 2/3] Initial commit: Plan for adding glossary definitions Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com> --- .github/workflows/daily-team-status.lock.yml | 1 + .github/workflows/go-file-size-reduction.campaign.g.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/daily-team-status.lock.yml b/.github/workflows/daily-team-status.lock.yml index 0bea7995e5..93d1b636e2 100644 --- a/.github/workflows/daily-team-status.lock.yml +++ b/.github/workflows/daily-team-status.lock.yml @@ -7002,6 +7002,7 @@ jobs: name: agent_output.json path: /tmp/gh-aw/threat-detection/ - name: Download patch artifact + if: needs.agent.outputs.has_patch == 'true' continue-on-error: true uses: actions/download-artifact@018cc2cf5baa6db3ef3c5f8a56943fffe632ef53 # v6 with: diff --git a/.github/workflows/go-file-size-reduction.campaign.g.md b/.github/workflows/go-file-size-reduction.campaign.g.md index 4fdea19129..1741f95d68 100644 --- a/.github/workflows/go-file-size-reduction.campaign.g.md +++ b/.github/workflows/go-file-size-reduction.campaign.g.md @@ -19,7 +19,7 @@ roles: --- - + # Campaign Orchestrator From ef71cf5ac5b74c0dbab45f2dec404bbc4591fbd9 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Mon, 15 Dec 2025 12:27:28 +0000 Subject: [PATCH 3/3] Add improved glossary definitions for technical jargon - Improve "agentic" definition on homepage to not use itself in definition - Add YAML basics callout in Quick Start before first YAML example - Enhance frontmatter and safe outputs explanations with clearer context - All definitions now use beginner-friendly language without assumed knowledge Co-authored-by: mnkiefer <8320933+mnkiefer@users.noreply.github.com> --- docs/src/content/docs/index.mdx | 4 ++-- docs/src/content/docs/setup/quick-start.md | 22 ++++++++++++++++++++-- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/docs/src/content/docs/index.mdx b/docs/src/content/docs/index.mdx index 59ef051803..8f5befce6b 100644 --- a/docs/src/content/docs/index.mdx +++ b/docs/src/content/docs/index.mdx @@ -44,6 +44,8 @@ import FeatureGrid from '../../components/FeatureGrid.astro'; ## What are Agentic Workflows? +**Agentic means the AI can think and decide for itself.** Unlike traditional automation that follows exact steps you program, agentic workflows give the AI a goal and let it figure out how to achieve it—like asking a smart assistant to "organize my issues" instead of writing code for every possible scenario. + **Agentic workflows** are AI-powered automation that can understand context, make decisions, and take meaningful actions—all from natural language instructions you write in markdown. Unlike traditional automation with fixed if-then rules, agentic workflows use AI agents (like GitHub Copilot) to: @@ -61,8 +63,6 @@ clarification if important details are missing. **To automated action**: The AI reads the issue, determines what's missing, and posts a helpful comment requesting specific information—adapting its response to each unique issue. -This is "agentic" because the AI acts as an intelligent agent with agency to make context-aware decisions, rather than just executing predefined steps. -
> **Part of the Continuous AI Initiative** diff --git a/docs/src/content/docs/setup/quick-start.md b/docs/src/content/docs/setup/quick-start.md index 0dfa2d7676..ef92d1967d 100644 --- a/docs/src/content/docs/setup/quick-start.md +++ b/docs/src/content/docs/setup/quick-start.md @@ -213,6 +213,24 @@ Once complete, a new discussion post will be created in your repository with a d Let's look at what you just added. The daily team status workflow automatically creates a status report every weekday and posts it as a discussion in your repository, and looks like this: +:::tip[YAML Basics for Beginners] +The configuration section uses **YAML syntax** (a human-friendly data format for configuration): +- `key: value` — Sets a configuration option +- `- item` — Creates a list item (note the dash and space) +- **Indentation matters** — Use 2 spaces for nested items (not tabs) +- Colons (`:`) separate keys from values +- Lists can be nested under keys + +**Example:** +```yaml +tools: # Key with nested items below + github: # Nested key (indented 2 spaces) + - repos # List item (dash + 2 spaces) +``` + +Learn more: [YAML Tutorial](https://learnxinyminutes.com/docs/yaml/) +::: + ```aw wrap --- on: @@ -248,11 +266,11 @@ This workflow triggers every weekday at 9 AM via cron schedule, has [permissions **Understanding the structure:** -- **[Frontmatter](/gh-aw/reference/glossary/#frontmatter)** (between `---` markers): The configuration section with [YAML](/gh-aw/reference/glossary/#yaml) settings that control when the workflow runs (`on:`), what permissions it has (`permissions:`), what tools it can use (`tools:`), and what outputs it can create (`safe-outputs:`). +- **[Frontmatter](/gh-aw/reference/glossary/#frontmatter)** (between `---` markers): A section at the top of the markdown file that contains configuration in [YAML](/gh-aw/reference/glossary/#yaml) format. It's commonly used in static site generators and documentation tools. In agentic workflows, frontmatter controls when the workflow runs (`on:`), what permissions it has (`permissions:`), what tools it can use (`tools:`), and what outputs it can create (`safe-outputs:`). - **Markdown body** (below frontmatter): Natural language instructions that tell the AI [agent](/gh-aw/reference/glossary/#agent) what tasks to perform. Written in plain English, not code. -- **[Safe outputs](/gh-aw/reference/glossary/#safe-outputs)**: Pre-approved actions (like creating discussions, issues, or comments) that the AI can request without needing write permissions during execution. The workflow processes these requests in separate, permission-controlled jobs for security. +- **[Safe outputs](/gh-aw/reference/glossary/#safe-outputs)**: Pre-approved actions (like creating discussions, issues, or comments) that the AI can request without needing write permissions during execution. This security feature prevents the AI from making unexpected changes—the workflow processes these requests in separate, permission-controlled jobs where humans can review what happened. ## Customize Your Workflow