diff --git a/docs/src/content/docs/reference/command-triggers.md b/docs/src/content/docs/reference/command-triggers.md index cd082e216d..6509a99e48 100644 --- a/docs/src/content/docs/reference/command-triggers.md +++ b/docs/src/content/docs/reference/command-triggers.md @@ -1,3 +1,8 @@ +--- +title: Command Triggers +description: Learn about command triggers and context text functionality for agentic workflows, including special @mention triggers for interactive automation. +--- + # 🏷️ Command Triggers This guide covers command triggers and context text functionality for agentic workflows. diff --git a/docs/src/content/docs/reference/commands.md b/docs/src/content/docs/reference/commands.md index 6da3fde812..a1e5e3973b 100644 --- a/docs/src/content/docs/reference/commands.md +++ b/docs/src/content/docs/reference/commands.md @@ -1,3 +1,8 @@ +--- +title: Workflow Management Commands +description: Complete guide to all available CLI commands for managing agentic workflows with the GitHub CLI extension, including installation, compilation, and execution. +--- + # 🛠️ Workflow Management Commands This guide covers all available commands for managing agentic workflows with the GitHub CLI extension. diff --git a/docs/src/content/docs/reference/concepts.md b/docs/src/content/docs/reference/concepts.md index 8cb94572e8..aad76b06e5 100644 --- a/docs/src/content/docs/reference/concepts.md +++ b/docs/src/content/docs/reference/concepts.md @@ -1,3 +1,8 @@ +--- +title: Introduction to GitHub Agentic Workflows +description: Learn the core concepts and capabilities of GitHub Agentic Workflows, combining AI agents with GitHub's collaboration platform for Continuous AI. +--- + # 📖 Introduction to GitHub Agentic Workflows Now that you've [got your first workflow running](quick-start.md), let's dive deeper into the concepts and capabilities of GitHub Agentic Workflows. diff --git a/docs/src/content/docs/reference/frontmatter.md b/docs/src/content/docs/reference/frontmatter.md index 15a3650a49..e89f2bd455 100644 --- a/docs/src/content/docs/reference/frontmatter.md +++ b/docs/src/content/docs/reference/frontmatter.md @@ -1,5 +1,6 @@ --- title: Frontmatter Options for GitHub Agentic Workflows +description: Complete guide to all available frontmatter configuration options for GitHub Agentic Workflows, including triggers, permissions, AI engines, and workflow settings. --- This guide covers all available frontmatter configuration options for GitHub Agentic Workflows. diff --git a/docs/src/content/docs/reference/include-directives.md b/docs/src/content/docs/reference/include-directives.md index 784103fe4f..064bce5788 100644 --- a/docs/src/content/docs/reference/include-directives.md +++ b/docs/src/content/docs/reference/include-directives.md @@ -1,3 +1,8 @@ +--- +title: Include Directives +description: Learn how to modularize and reuse workflow components across multiple workflows using include directives for better organization and maintainability. +--- + # 📝 Include Directives Include directives allow you to modularize and reuse workflow components across multiple workflows. diff --git a/docs/src/content/docs/reference/index.md b/docs/src/content/docs/reference/index.md index bd51b6f1bb..8c76802c18 100644 --- a/docs/src/content/docs/reference/index.md +++ b/docs/src/content/docs/reference/index.md @@ -1,3 +1,8 @@ +--- +title: GitHub Agentic Workflows Documentation +description: Write agentic workflows in natural language markdown and run them in GitHub Actions. Complete documentation for GitHub's research demonstrator from GitHub Next. +--- + # 📖 GitHub Agentic Workflows Documentation Write agentic workflows in natural language markdown, and run them in GitHub Actions. From [GitHub Next](https://githubnext.com/). diff --git a/docs/src/content/docs/reference/mcps.md b/docs/src/content/docs/reference/mcps.md index 245b88fa05..525eb51a83 100644 --- a/docs/src/content/docs/reference/mcps.md +++ b/docs/src/content/docs/reference/mcps.md @@ -1,3 +1,8 @@ +--- +title: Model Context Protocol (MCP) Integration Guide +description: Learn how to use Model Context Protocol (MCP) servers with GitHub Agentic Workflows to connect AI agents to external tools, databases, and services. +--- + # 🔌 Model Context Protocol (MCP) Integration Guide This guide covers using Model Context Protocol (MCP) servers with GitHub Agentic Workflows. diff --git a/docs/src/content/docs/reference/quick-start.md b/docs/src/content/docs/reference/quick-start.md index cf7e3107e7..e2ff9d4bf7 100644 --- a/docs/src/content/docs/reference/quick-start.md +++ b/docs/src/content/docs/reference/quick-start.md @@ -1,3 +1,8 @@ +--- +title: Quick Start Guide +description: Get your first agentic workflow running in minutes. Install the extension, add a sample workflow, set up secrets, and run your first AI-powered automation. +--- + # 🚀 Quick Start — Get your first workflow running This guide will get you from zero to a running agentic workflow in minutes. You'll install the extension, add a sample workflow, set up the required secrets, and run it. diff --git a/docs/src/content/docs/reference/safe-outputs.md b/docs/src/content/docs/reference/safe-outputs.md index 99fa65b104..89409f278b 100644 --- a/docs/src/content/docs/reference/safe-outputs.md +++ b/docs/src/content/docs/reference/safe-outputs.md @@ -1,3 +1,8 @@ +--- +title: Safe Output Processing +description: Learn about safe output processing features that enable creating GitHub issues, comments, and pull requests without giving workflows write permissions. +--- + # 🔒 Safe Output Processing One of the primary security features of GitHub Agentic Workflows is "safe output processing", enabling the creation of GitHub issues, comments, pull requests, and other outputs without giving the agentic portion of the workflow write permissions. diff --git a/docs/src/content/docs/reference/samples.md b/docs/src/content/docs/reference/samples.md index 7040f0428e..890402dc93 100644 --- a/docs/src/content/docs/reference/samples.md +++ b/docs/src/content/docs/reference/samples.md @@ -1,3 +1,8 @@ +--- +title: Sample Workflows +description: Collection of demonstrator agentic workflows for research, planning, coding, and development tasks that you can use as starting points for your own automation. +--- + # Sample Workflows **Demonstrator Research & Planning Workflows** diff --git a/docs/src/content/docs/reference/secrets.md b/docs/src/content/docs/reference/secrets.md index d6cc44b770..004d72a0bb 100644 --- a/docs/src/content/docs/reference/secrets.md +++ b/docs/src/content/docs/reference/secrets.md @@ -1,3 +1,8 @@ +--- +title: Secrets Management +description: Learn how agentic workflows handle secrets automatically and how to configure custom secret references for secure AI automation. +--- + # 🔐 Secrets Management Agentic workflows automatically handle several types of secrets and support custom secret references. diff --git a/docs/src/content/docs/reference/security-notes.md b/docs/src/content/docs/reference/security-notes.md index 39d45bcff6..0b300a474e 100644 --- a/docs/src/content/docs/reference/security-notes.md +++ b/docs/src/content/docs/reference/security-notes.md @@ -1,3 +1,8 @@ +--- +title: Security Notes +description: Important security considerations for GitHub Agentic Workflows, including sandboxing, permissions, and best practices for safe agentic automation. +--- + # Security Notes > [!CAUTION] diff --git a/docs/src/content/docs/reference/tools.md b/docs/src/content/docs/reference/tools.md index 2b01295655..163c4d12d9 100644 --- a/docs/src/content/docs/reference/tools.md +++ b/docs/src/content/docs/reference/tools.md @@ -1,3 +1,8 @@ +--- +title: Tools Configuration +description: Configure GitHub API tools and AI capabilities available to your agentic workflows, including GitHub tools and Claude-specific integrations. +--- + # 🔧 Tools Configuration This guide covers the available tools that can be configured in agentic workflows, including GitHub tools and Claude-specific tools. diff --git a/docs/src/content/docs/reference/vscode.md b/docs/src/content/docs/reference/vscode.md index 2c54a34096..e5ff70fefc 100644 --- a/docs/src/content/docs/reference/vscode.md +++ b/docs/src/content/docs/reference/vscode.md @@ -1,3 +1,8 @@ +--- +title: Visual Studio Code Integration +description: Learn about the gh aw CLI tools for improving your developer experience in Visual Studio Code and other IDEs, including Copilot instructions. +--- + # Visual Studio Code Integration The `gh aw` cli provides a few tools to improve your developer experience in Visual Studio Code (or other IDEs). diff --git a/docs/src/content/docs/reference/workflow-structure.md b/docs/src/content/docs/reference/workflow-structure.md index 9fe57fa702..2ff4447f26 100644 --- a/docs/src/content/docs/reference/workflow-structure.md +++ b/docs/src/content/docs/reference/workflow-structure.md @@ -1,3 +1,8 @@ +--- +title: Workflow Structure +description: Learn how agentic workflows are organized and structured within your repository, including directory layout and file organization. +--- + # 📋 Workflow Structure This guide explains how agentic workflows are organized and structured within your repository.