Skip to content

Commit 83a39e7

Browse files
rootroot
root
authored and
root
committed
docs(planning): mark v1.0 baseline phases complete
1 parent 8e8b838 commit 83a39e7

2 files changed

Lines changed: 58 additions & 58 deletions

File tree

‎.planning/MILESTONES.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
| Phase | Name | Requirements | Status |
1111
|---|---|---|---|
12-
| 1 | CI Setup | CI-01 | Not started |
13-
| 2 | Component Completion | NANO-01, NANO-02, TEST-01 | Not started |
14-
| 3 | Unified README | DOC-01 | Not started |
12+
| 1 | CI Setup | CI-01 | Complete |
13+
| 2 | Component Completion | NANO-01, NANO-02, TEST-01 | Complete |
14+
| 3 | Unified README | DOC-01 | Complete |
1515

1616
**Definition of done:** All 5 requirements complete, CI green, README published.

‎.planning/ROADMAP.md‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,55 @@
1-
# Roadmap — gemini-nano
2-
3-
**Milestone:** v1.0 Research Baseline
4-
**Granularity:** Standard
5-
**Coverage:** 5/5 requirements mapped
6-
7-
## Phases
8-
9-
- [x] **Phase 1: CI Setup** - GitHub Actions workflow lints and validates the project on every push
10-
- [x] **Phase 2: Component Completion** - chrome-bridge gets a real health test; python-mediapipe gets graceful fallback and CLI argument
11-
- [x] **Phase 3: Unified README** - Single README documents the architecture and quick-start for all components
12-
13-
## Phase Details
14-
15-
### Phase 1: CI Setup
16-
**Goal**: Every push to the repo triggers automated validation that catches regressions in api-server and confirms chrome-bridge installs cleanly
17-
**Depends on**: Nothing (first phase)
18-
**Requirements**: CI-01
19-
**Success Criteria** (what must be TRUE):
20-
1. A push to any branch triggers the GitHub Actions workflow without manual intervention
21-
2. `api-server/` Python dependencies install and ruff lint passes with no errors
22-
3. `chrome-bridge/` npm dependencies install cleanly via `npm ci`
23-
4. The workflow completes green on a machine without Ollama (test_api.py skipped or collected-only)
24-
**Plans**: TBD
25-
26-
### Phase 2: Component Completion
27-
**Goal**: Users can run python-mediapipe/run_nano.py without a cryptic crash when the model is absent, and chrome-bridge has an automated health check that runs without Chrome
28-
**Depends on**: Phase 1
29-
**Requirements**: NANO-01, NANO-02, TEST-01
30-
**Success Criteria** (what must be TRUE):
31-
1. Running `python run_nano.py` with no `model.task` file prints a clear download instruction and exits with code 0
32-
2. Running `python run_nano.py --model-path /custom/path.task` uses the specified path (with same graceful fallback if absent)
33-
3. Running `npm test` in `chrome-bridge/` starts a server, hits `/health`, asserts `{"status": "ok"}`, and exits 0 — no Chrome installation required
34-
4. The npm test is included in the CI workflow (Phase 1 updated or CI-01 fully satisfied)
35-
**Plans**: TBD
36-
37-
### Phase 3: Unified README
38-
**Goal**: Any developer can understand the project architecture and start each component in under 5 minutes using only the README
39-
**Depends on**: Phase 2
40-
**Requirements**: DOC-01
41-
**Success Criteria** (what must be TRUE):
42-
1. `gemini-nano/README.md` exists and contains a component table with directory, language, port, and status columns
43-
2. README contains a Mermaid architecture diagram showing how api-server, chrome-bridge, chrome-demo, and python-mediapipe relate
44-
3. README contains quick-start commands (copy-pasteable) for each component
45-
4. README links to SETUP.md for Chrome flag configuration details
46-
**Plans**: TBD
47-
**UI hint**: yes
48-
49-
## Progress Table
50-
51-
| Phase | Plans Complete | Status | Completed |
52-
|---|---|---|---|
53-
| 1. CI Setup | 0/1 | Not started | - |
54-
| 2. Component Completion | 0/3 | Not started | - |
55-
| 3. Unified README | 0/1 | Not started | - |
1+
# Roadmap — gemini-nano
2+
3+
**Milestone:** v1.0 Research Baseline
4+
**Granularity:** Standard
5+
**Coverage:** 5/5 requirements mapped
6+
7+
## Phases
8+
9+
- [x] **Phase 1: CI Setup** - GitHub Actions workflow lints and validates the project on every push
10+
- [x] **Phase 2: Component Completion** - chrome-bridge gets a real health test; python-mediapipe gets graceful fallback and CLI argument
11+
- [x] **Phase 3: Unified README** - Single README documents the architecture and quick-start for all components
12+
13+
## Phase Details
14+
15+
### Phase 1: CI Setup
16+
**Goal**: Every push to the repo triggers automated validation that catches regressions in api-server and confirms chrome-bridge installs cleanly
17+
**Depends on**: Nothing (first phase)
18+
**Requirements**: CI-01
19+
**Success Criteria** (what must be TRUE):
20+
1. A push to any branch triggers the GitHub Actions workflow without manual intervention
21+
2. `api-server/` Python dependencies install and ruff lint passes with no errors
22+
3. `chrome-bridge/` npm dependencies install cleanly via `npm ci`
23+
4. The workflow completes green on a machine without Ollama (test_api.py skipped or collected-only)
24+
**Plans**: TBD
25+
26+
### Phase 2: Component Completion
27+
**Goal**: Users can run python-mediapipe/run_nano.py without a cryptic crash when the model is absent, and chrome-bridge has an automated health check that runs without Chrome
28+
**Depends on**: Phase 1
29+
**Requirements**: NANO-01, NANO-02, TEST-01
30+
**Success Criteria** (what must be TRUE):
31+
1. Running `python run_nano.py` with no `model.task` file prints a clear download instruction and exits with code 0
32+
2. Running `python run_nano.py --model-path /custom/path.task` uses the specified path (with same graceful fallback if absent)
33+
3. Running `npm test` in `chrome-bridge/` starts a server, hits `/health`, asserts `{"status": "ok"}`, and exits 0 — no Chrome installation required
34+
4. The npm test is included in the CI workflow (Phase 1 updated or CI-01 fully satisfied)
35+
**Plans**: TBD
36+
37+
### Phase 3: Unified README
38+
**Goal**: Any developer can understand the project architecture and start each component in under 5 minutes using only the README
39+
**Depends on**: Phase 2
40+
**Requirements**: DOC-01
41+
**Success Criteria** (what must be TRUE):
42+
1. `gemini-nano/README.md` exists and contains a component table with directory, language, port, and status columns
43+
2. README contains a Mermaid architecture diagram showing how api-server, chrome-bridge, chrome-demo, and python-mediapipe relate
44+
3. README contains quick-start commands (copy-pasteable) for each component
45+
4. README links to SETUP.md for Chrome flag configuration details
46+
**Plans**: TBD
47+
**UI hint**: yes
48+
49+
## Progress Table
50+
51+
| Phase | Plans Complete | Status | Completed |
52+
|---|---|---|---|
53+
| 1. CI Setup | 1/1 | Complete | 2026-07-06 |
54+
| 2. Component Completion | 3/3 | Complete | 2026-07-06 |
55+
| 3. Unified README | 1/1 | Complete | 2026-07-06 |

0 commit comments

Comments
 (0)