Skip to content

Commit ea9a5da

Browse files
committed
docs: clarify control plane boundary
1 parent 42acf9a commit ea9a5da

2 files changed

Lines changed: 32 additions & 9 deletions

File tree

README.md

Lines changed: 24 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,16 @@
33
[![CI](https://github.com/Coding-Autopilot-System/autopilot-core/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/autopilot-core/actions/workflows/ci.yml)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
55

6-
**Org-level AI autopilot operator** scans GitHub issues labeled `autofix + queued`, invokes Codex to generate fixes, and opens pull requests automatically across the Coding-Autopilot-System organization.
6+
**Org-level AI autopilot control plane** - scans GitHub issues labeled `autofix + queued`, invokes Codex to generate fixes, and opens pull requests automatically across the Coding-Autopilot-System organization.
77

88
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) autonomous CI repair platform alongside [ci-autopilot](https://github.com/Coding-Autopilot-System/ci-autopilot) and [autopilot-demo](https://github.com/Coding-Autopilot-System/autopilot-demo).
99

10+
## Repo boundary
11+
12+
- `autopilot-core` is the control plane: org-wide intake governance, operator scheduling, PR creation, and rollout visibility.
13+
- `ci-autopilot` is the worker/runtime pattern: the runner-hosted Python agent and workflow assets used to execute repairs.
14+
- `autopilot-demo` is the proof repo: a safe target that demonstrates the full failure-to-fix loop.
15+
1016
## How it works
1117

1218
```mermaid
@@ -28,30 +34,39 @@ flowchart LR
2834
## Quick start
2935

3036
1. Set org variable `ORG` in GitHub Actions for this repo.
31-
2. Install `autopilot-create-issue.yml` into target repos (or use `autopilot-org-installer.yml`).
37+
2. Install `autopilot-create-issue.yml` into target repos, or use `autopilot-org-installer.yml`.
3238
3. Ensure a self-hosted Windows runner with Codex and `OPENAI_API_KEY` is online.
3339
4. Trigger `autopilot-operator.yml` manually to validate the setup.
3440

41+
## Enterprise proof points
42+
43+
- Centralized control plane with explicit issue-queue handoff instead of opaque direct mutation.
44+
- Auditable lifecycle: CI failure, intake issue, operator run, fix branch, and PR are all visible in GitHub.
45+
- Guardrailed execution: label-gated intake, skip labels for risky work, and verification before PR creation.
46+
- Org-scale rollout path: installer workflow distributes intake automation to opted-in repositories.
47+
3548
## Safety guardrails
3649

3750
- Acts only on issues labeled `autofix + queued`.
3851
- Skips issues labeled `risky` or `needs-design`.
39-
- Minimal diffs only no secrets, no destructive operations.
52+
- Minimal diffs only - no secrets, no destructive operations.
4053
- Best-effort verification before PR creation.
4154

4255
## Workflows
4356

4457
| Workflow | Trigger | Purpose |
4558
|----------|---------|---------|
46-
| `ci.yml` | push/PR to main | Portfolio CI YAML validation (ubuntu-latest) |
47-
| `autopilot-operator.yml` | schedule + dispatch | Core operator scan issues, run Codex, open PRs |
59+
| `ci.yml` | push/PR to main | Portfolio CI - YAML validation (ubuntu-latest) |
60+
| `autopilot-operator.yml` | schedule + dispatch | Core operator - scan issues, run Codex, open PRs |
4861
| `autopilot-org-installer.yml` | hourly + dispatch | Install intake workflow into opted-in repos |
4962
| `autopilot-create-issue.yml` | workflow_run failure | Create intake issue when monitored workflow fails |
5063
| `autopilot-docs-daily.yml` | daily | Update dashboard status page |
5164

5265
## Documentation
5366

54-
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-core/wiki) — setup guide, architecture, configuration reference
55-
- [Dashboard](https://coding-autopilot-system.github.io/autopilot-core/) — live autopilot status
56-
- `docs/status.md` — status snapshot
57-
- `docs/runbooks/` — operational runbooks
67+
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-core/wiki) - setup guide, architecture, configuration reference
68+
- [Dashboard](https://coding-autopilot-system.github.io/autopilot-core/) - live autopilot status
69+
- [docs/status.md](docs/status.md) - status snapshot
70+
- [docs/runbooks/operator.md](docs/runbooks/operator.md) - operator runbook
71+
- [docs/runbooks/install-to-repo.md](docs/runbooks/install-to-repo.md) - repo onboarding runbook
72+
- [docs/demos/demo-repo.md](docs/demos/demo-repo.md) - demo walkthrough using `autopilot-demo`
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# 20260610_autopilot-core_boundary-readme
2+
3+
Issue Description: README did not clearly distinguish control plane responsibilities from worker/runtime and demo repos.
4+
State: Portfolio readers could not quickly tell what `autopilot-core` owns.
5+
Action: Added a repo boundary section, enterprise proof points, and direct runbook/demo links in `README.md`.
6+
Result: The repo now presents itself as the org-level control plane with clearer adjacent-repo boundaries.
7+
Diff Patch: Updated `README.md` only.
8+
Rationale: Hiring and architecture readers need the control-plane role to be obvious within the first screen.

0 commit comments

Comments
 (0)