diff --git a/README.md b/README.md index d0a2f4f..30d7303 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ AI-powered GitHub workflows for Elastic repositories. Full documentation lives at https://elastic.github.io/ai-github-actions/. -- GitHub Agent Workflows (recommended): https://elastic.github.io/ai-github-actions/workflows/gh-agent-workflows/ +- Elastic AI Software Factory (GitHub Agent Workflows, recommended): https://elastic.github.io/ai-github-actions/workflows/gh-agent-workflows/ - Legacy Claude Composite Actions: https://elastic.github.io/ai-github-actions/workflows/claude-workflows/ - Developing: https://elastic.github.io/ai-github-actions/developing/ - Security: https://elastic.github.io/ai-github-actions/security/ @@ -16,9 +16,14 @@ Full documentation lives at https://elastic.github.io/ai-github-actions/. ## Overview -- GitHub Agent Workflows are the primary/recommended path and provide safe-output guardrails with configurable engines. +- Elastic AI Software Factory (GitHub Agent Workflows) is the primary/recommended path and provides safe-output guardrails with configurable engines. - Claude Composite Actions remain supported as a legacy option with RO/RWX/RWXP permission variants. +## Top recommended workflows + +- Starter repo operations set: `pr-review`, `issue-triage`, `mention-in-issue`, `mention-in-pr`, `pr-actions-detective` +- Continuous improvement set: `bug-hunter`, `bug-exterminator`, `code-simplifier`, `docs-patrol`, `newbie-contributor-patrol`, `small-problem-fixer`, `stale-issues`, `test-improver`, `breaking-change-detector`, `code-duplication-detector`, `update-pr-body` + ## Quick setup script Run from the repository you want to configure (requires `gh` (authenticated via `gh auth login`), `git`, and `curl`): diff --git a/docs/index.md b/docs/index.md index 12f15ae..6ff7442 100644 --- a/docs/index.md +++ b/docs/index.md @@ -4,7 +4,7 @@ AI-powered GitHub workflows for Elastic repositories. -## Recommended approach +## Elastic AI Software Factory (recommended) | Feature | GitHub Agent Workflows | | --- | --- | @@ -12,12 +12,36 @@ AI-powered GitHub workflows for Elastic repositories. | Install | Copy trigger YAML (recommended) | | Guardrails | Safe-outputs framework (structured API outputs) | | Customization | `additional-instructions`, `setup-commands`, or full shim edit | +| Also called | Elastic AI Software Factory | -GitHub Agent Workflows are recommended for all new deployments and ongoing maintenance. +Elastic AI Software Factory (GitHub Agent Workflows) is recommended for all new deployments and ongoing maintenance. + +## Top recommended workflows + +### Starter repo operations set + +- `pr-review` +- `issue-triage` +- `mention-in-issue` +- `mention-in-pr` +- `pr-actions-detective` + +### Continuous improvement add-ons + +- `bug-hunter` + `bug-exterminator` +- `code-simplifier` +- `docs-patrol` +- `newbie-contributor-patrol` +- `small-problem-fixer` +- `stale-issues` +- `test-improver` +- `breaking-change-detector` +- `code-duplication-detector` +- `update-pr-body` ## Workflows -- [GitHub Agent Workflows](workflows/gh-agent-workflows.md) +- [Elastic AI Software Factory (GitHub Agent Workflows)](workflows/gh-agent-workflows.md) ## Legacy diff --git a/docs/workflows/gh-agent-workflows.md b/docs/workflows/gh-agent-workflows.md index 4e9f8a8..4f46977 100644 --- a/docs/workflows/gh-agent-workflows.md +++ b/docs/workflows/gh-agent-workflows.md @@ -1,6 +1,6 @@ -# GitHub Agent Workflows +# Elastic AI Software Factory (GitHub Agent Workflows) -GitHub Agentic Workflows with safe-output guardrails. Engine and model are configurable per workflow, and updates are delivered via the `v0` tag. +Elastic AI Software Factory is built on GitHub Agent Workflows with safe-output guardrails. Engine and model are configurable per workflow, and updates are delivered via the `v0` tag. ## Install (caller-based, recommended) @@ -21,6 +21,13 @@ jobs: Each workflow directory contains an `example.yml` starter and a README for trigger details, inputs, and safe outputs. +## Recommended workflow sets + +The quick setup script includes two opinionated sets: + +- **Starter repo operations set (default):** `pr-review`, `issue-triage`, `mention-in-issue`, `mention-in-pr`, `pr-actions-detective` +- **Continuous improvement add-ons (`--continuous-improvement`):** `bug-hunter`, `bug-exterminator`, `code-simplifier`, `docs-patrol`, `newbie-contributor-patrol`, `small-problem-fixer`, `stale-issues`, `test-improver`, `breaking-change-detector`, `code-duplication-detector`, `update-pr-body` + ## Available workflows ### Base workflows diff --git a/mkdocs.yml b/mkdocs.yml index 159fc7a..aa4cc53 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -11,7 +11,7 @@ hooks: nav: - Home: index.md - Workflows: - - GitHub Agent Workflows: + - Elastic AI Software Factory (GitHub Agent Workflows): - Overview: workflows/gh-agent-workflows.md - Base Workflows: - Scheduled Audit: workflows/gh-agent-workflows/scheduled-audit.md