Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Deploy Documentation to GitHub Pages

on:
workflow_dispatch:
release:
types: [created]

# Allow this job to clone the repo and create a page deployment
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'
cache-dependency-path: 'docs/package-lock.json'

- name: Install dependencies
working-directory: ./docs
run: npm ci

- name: Build documentation
working-directory: ./docs
run: npm run build

- name: Upload build artifacts
uses: actions/upload-pages-artifact@v3
with:
path: ./docs/dist

deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
69 changes: 53 additions & 16 deletions docs/src/content/docs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,36 +1,73 @@
---
title: Welcome to Starlight
description: Get started building your docs site with Starlight.
title: GitHub Agentic Workflows
description: Write agentic workflows in natural language markdown and run them safely in GitHub Actions. AI-powered automation for your repositories.
template: splash
hero:
tagline: Congrats on setting up a new Starlight project!
tagline: Write agentic workflows in natural language markdown, and run them safely in GitHub Actions
image:
file: ../../assets/houston.webp
actions:
- text: Example Guide
link: /guides/example/
- text: Quick Start Guide
link: /reference/quick-start/
icon: right-arrow
- text: Read the Starlight docs
link: https://starlight.astro.build
- text: View on GitHub
link: https://github.com/githubnext/gh-aw
icon: external
variant: minimal
---

import { Card, CardGrid } from '@astrojs/starlight/components';

## Next steps
## ✨ AI-Powered Repository Automation

GitHub Agentic Workflows combines the power of AI agents with GitHub's collaboration platform to enable **Continuous AI** — the systematic, automated application of AI to software collaboration.

Transform natural language descriptions into intelligent GitHub Actions that can understand context, make decisions, and take meaningful actions across your repositories.

<CardGrid stagger>
<Card title="Update content" icon="pencil">
Edit `src/content/docs/index.mdx` to see this page change.
<Card title="🚀 Quick Start" icon="rocket">
Get your first agentic workflow running in minutes. Learn how to install the extension and set up AI-powered automation.
[Get Started →](/reference/quick-start/)
</Card>
<Card title="Add new content" icon="add-document">
Add Markdown or MDX files to `src/content/docs` to create new pages.
<Card title="📖 Learn Concepts" icon="open-book">
Understand how agentic workflows work and explore the capabilities of AI-driven repository automation.
[Learn More →](/reference/concepts/)
</Card>
<Card title="Configure your site" icon="setting">
Edit your `sidebar` and other config in `astro.config.mjs`.
<Card title="🔧 Browse Commands" icon="setting">
Explore all available CLI commands for managing agentic workflows with the GitHub CLI extension.
[View Commands →](/reference/commands/)
</Card>
<Card title="Read the docs" icon="open-book">
Learn more in [the Starlight Docs](https://starlight.astro.build/).
<Card title="🔒 Security Guide" icon="lock">
Learn about security considerations, permissions, and best practices for safe agentic automation.
[Security Notes →](/reference/security-notes/)
</Card>
</CardGrid>

## 🔥 Key Features

- **Natural Language Workflows**: Write automation in markdown instead of complex YAML
- **AI-Powered Decision Making**: Workflows that understand context and adapt to situations
- **GitHub Integration**: Deep integration with issues, PRs, discussions, and repository management
- **Security First**: Sandboxed execution with minimal permissions and safe output processing
- **Multiple AI Engines**: Support for Claude, Codex, and custom AI processors

## 🎯 Common Use Cases

<CardGrid>
<Card title="🏷️ Intelligent Triage" icon="tag">
Automatically analyze and triage issues and pull requests with AI-powered insights.
</Card>
<Card title="📚 Documentation Automation" icon="document">
Keep documentation current with AI that understands your codebase and updates.
</Card>
<Card title="🔍 Code Quality" icon="magnifier">
Automated code review, dependency updates, and continuous quality improvements.
</Card>
<Card title="📊 Research & Planning" icon="information">
Weekly research reports, team status updates, and planning automation.
</Card>
</CardGrid>

## ⚠️ Research Project Notice

> **GitHub Agentic Workflows is a research demonstrator from [GitHub Next](https://githubnext.com/) and [Microsoft Research](https://www.microsoft.com/en-us/research/group/research-software-engineering-rise/).** It is in early development and may change significantly. Using agentic workflows requires careful attention to security considerations and human supervision. Use with caution and at your own risk.