Skip to content

Commit f57d500

Browse files
OgeonX-AiAitomates
OgeonX-Ai
and
Aitomates
authored
Harden autopilot-demo portfolio docs (#3)
* docs: clarify demo repo boundary * docs: correct demo PR monitoring wording --------- Co-authored-by: Kim Harjamäki <kim.harjamaki@prosimo.fi>
1 parent fee614a commit f57d500

8 files changed

Lines changed: 130 additions & 8 deletions

File tree

‎.planning/ROADMAP.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Roadmap
2+
3+
## Current Focus
4+
5+
Maintain accurate, reproducible portfolio demo documentation.

‎.planning/STATE.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Project State
2+
3+
Last activity: 2026-06-10 - Completed quick task 260610-ppt: Correct README monitor wording to match autopilot-demo
4+
5+
### Blockers/Concerns
6+
7+
None.
8+
9+
### Quick Tasks Completed
10+
11+
| # | Description | Date | Commit | Status | Directory |
12+
|---|-------------|------|--------|--------|-----------|
13+
| 260610-ppt | Correct README monitor wording to match autopilot-demo | 2026-06-10 | this atomic task commit | Verified | [260610-ppt-fix-pr-3-follow-up-readme-monitor-wordin](./quick/260610-ppt-fix-pr-3-follow-up-readme-monitor-wordin/) |

‎.planning/quick/260610-ppt-fix-pr-3-follow-up-readme-monitor-wordin/260610-ppt-PLAN.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
quick_id: 260610-ppt
3+
mode: quick-full
4+
status: complete
5+
date: 2026-06-10
6+
---
7+
8+
# Correct README monitor wording to match autopilot-demo
9+
10+
## Goal
11+
12+
Correct the PR #3 follow-up wording so the README comment names the same repository queried by the following command.
13+
14+
## Tasks
15+
16+
1. Update the README monitoring comment from `autopilot-core` to `autopilot-demo`.
17+
2. Record the successful fix in `memory/examples/` as required by `AGENTS.md`.
18+
3. Verify the intended wording, unchanged command target, branch, and patch formatting.
19+
20+
## Must Haves
21+
22+
- The monitoring comment says `Monitor autopilot-demo for the fix PR`.
23+
- The following command remains `gh pr list -R Coding-Autopilot-System/autopilot-demo`.
24+
- `git diff --check` passes.
25+
- The work remains on `docs/portfolio-hardening-20260610`.
26+
27+
## Plan Check
28+
29+
Passed: the plan covers the requested wording correction, repo-local memory requirement, branch constraint, and explicit validation gate without unrelated changes.

‎.planning/quick/260610-ppt-fix-pr-3-follow-up-readme-monitor-wordin/260610-ppt-SUMMARY.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
quick_id: 260610-ppt
3+
status: complete
4+
date: 2026-06-10
5+
---
6+
7+
# Summary
8+
9+
Corrected the README monitoring comment so it names `autopilot-demo`, matching the following `gh pr list` command.
10+
11+
## Changes
12+
13+
- Updated one README comment.
14+
- Added the repo-required successful-fix memory entry.
15+
- Bootstrapped minimal local GSD project state and recorded this validated quick task.
16+
17+
## Result
18+
19+
The PR monitoring instruction and command now consistently target `autopilot-demo`.

‎.planning/quick/260610-ppt-fix-pr-3-follow-up-readme-monitor-wordin/260610-ppt-VERIFICATION.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
quick_id: 260610-ppt
3+
status: passed
4+
date: 2026-06-10
5+
---
6+
7+
# Verification
8+
9+
## Checks
10+
11+
- Passed: current branch is `docs/portfolio-hardening-20260610`.
12+
- Passed: `# Monitor autopilot-demo for the fix PR` exists exactly once.
13+
- Passed: `# Monitor autopilot-core for the fix PR` is absent.
14+
- Passed: `gh pr list -R Coding-Autopilot-System/autopilot-demo` remains present exactly once.
15+
- Passed: `gsd-sdk query init.quick` detects both roadmap and planning state.
16+
- Passed: `git diff --check`.
17+
18+
## Status
19+
20+
Passed. All task must-haves are satisfied.

‎README.md‎

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,15 @@
44
[![Demo CI](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/demo-ci.yml/badge.svg?branch=main)](https://github.com/Coding-Autopilot-System/autopilot-demo/actions/workflows/demo-ci.yml)
55
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
66

7-
**Demo target for the Coding-Autopilot-System AI repair pipeline** — triggers intake workflows when CI fails, demonstrating end-to-end agentic fix from failure detection to pull request.
7+
**Demo target for the Coding-Autopilot-System AI repair pipeline** - triggers intake workflows when CI fails, demonstrating the end-to-end path from failure detection to pull request.
88

9-
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) autonomous CI repair platform. The control plane lives in [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core).
9+
Part of the [Coding-Autopilot-System](https://github.com/Coding-Autopilot-System) autonomous CI repair platform. The control plane lives in [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core), and the runner-hosted worker/runtime pattern lives in [ci-autopilot](https://github.com/Coding-Autopilot-System/ci-autopilot).
10+
11+
## Repo boundary
12+
13+
- `autopilot-demo` is not the operator and not the worker host. It is the demonstration target repo.
14+
- `autopilot-core` owns queue scanning, Codex invocation, and PR creation.
15+
- `ci-autopilot` shows the worker/runtime implementation used to process queued repair tasks.
1016

1117
## How the demo works
1218

@@ -35,20 +41,34 @@ gh workflow run demo-ci.yml -R Coding-Autopilot-System/autopilot-demo
3541
# Watch for the intake issue to be created
3642
gh issue list -R Coding-Autopilot-System/autopilot-demo --label autofix --label queued
3743

38-
# Monitor autopilot-core for the fix PR
44+
# Monitor autopilot-demo for the fix PR
3945
gh pr list -R Coding-Autopilot-System/autopilot-demo
4046
```
4147

48+
## Demo runbook
49+
50+
1. Trigger [`.github/workflows/demo-ci.yml`](.github/workflows/demo-ci.yml) to produce a known failure signal.
51+
2. Confirm [`.github/workflows/autopilot-create-issue.yml`](.github/workflows/autopilot-create-issue.yml) creates an `autofix + queued` issue.
52+
3. Watch `autopilot-core` pick up the issue and open a PR back into this repo.
53+
4. Use this repo's issue, branch, and PR history as the audit trail for the demo.
54+
55+
## Enterprise proof points
56+
57+
- Demonstrates bounded blast radius: the platform proposes a fix in a dedicated target repo before broader rollout.
58+
- Produces an auditable story for reviewers: failure event, queued issue, operator pickup, and PR are visible artifacts.
59+
- Keeps the demo reproducible with workflow-dispatch entry points rather than hidden local steps.
60+
4261
## Workflows
4362

4463
| Workflow | Purpose |
4564
|----------|---------|
46-
| `ci.yml` | Portfolio CI — YAML validation (always passes) |
47-
| `demo-ci.yml` | Demo trigger — simulates CI activity to test intake flow |
48-
| `autopilot-create-issue.yml` | Intake — creates autofix+queued issue on workflow failure |
65+
| `ci.yml` | Portfolio CI - YAML validation (always passes) |
66+
| `demo-ci.yml` | Demo trigger - simulates CI activity to test intake flow |
67+
| `autopilot-create-issue.yml` | Intake - creates `autofix + queued` issue on workflow failure |
4968

5069
## Documentation
5170

52-
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-demo/wiki) — setup guide, architecture, configuration reference
53-
- [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core) — operator control plane
71+
- [Wiki](https://github.com/Coding-Autopilot-System/autopilot-demo/wiki) - setup guide, architecture, configuration reference
72+
- [autopilot-core](https://github.com/Coding-Autopilot-System/autopilot-core) - operator control plane
73+
- [ci-autopilot](https://github.com/Coding-Autopilot-System/ci-autopilot) - worker/runtime reference
5474
- [Coding-Autopilot-System org](https://github.com/Coding-Autopilot-System)

‎memory/examples/20260610_autopilot-demo_boundary-readme.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# 20260610_autopilot-demo_boundary-readme
2+
3+
Issue Description: README did not strongly frame the repo as the demo target in a three-repo story.
4+
State: The demo flow was present, but the target-only role and audit value were underexplained.
5+
Action: Added repo boundary language, a concise demo runbook, and enterprise proof points in `README.md`.
6+
Result: The repo now reads as a bounded demonstration target with a clear audit trail.
7+
Diff Patch: Updated `README.md` only.
8+
Rationale: Hiring reviewers should understand why the demo repo exists and how to reproduce the story quickly.

‎memory/examples/20260610_readme-monitor-target.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# 20260610_readme-monitor-target
2+
3+
Issue Description: The README said to monitor `autopilot-core`, but the command listed PRs from `autopilot-demo`.
4+
State: The prose and command target disagreed.
5+
Action: Changed the monitoring comment to name `autopilot-demo`.
6+
Result: The README now accurately describes the command that follows.
7+
Diff Patch: Updated one comment in `README.md`.
8+
Rationale: Operational documentation should name the repository actually queried by the command.

0 commit comments

Comments
 (0)