docs: prepare v1 milestone release

This commit is contained in:
2026-06-16 10:58:31 +01:00
parent 5a078bb108
commit f4fa1cdbf6
9 changed files with 1089 additions and 166 deletions
+42 -9
View File
@@ -12,6 +12,8 @@ Planning complete. Phase 0 complete. Phase 1 complete. Phase 2 complete. Phase 3
All planned phases complete. Provider abstraction (Phase 6), integration tests (Phase 7), manual export provider (Phase 8), and Ollama provider (Phase 9) finished. **3 supported providers: openai, manual, ollama.**
Task 10.3 — Local Setup Helper implemented (interactive onboarding for `.env` and Claude Code config).
## Completed Tasks
- Task 0.1 — Create repository skeleton ✅
@@ -116,7 +118,7 @@ Project-local Claude Code discovery configured:
- Task 7.4 — Final integration verification ✅
- All 579 tests pass across 20 test files with zero regressions
- All 701 tests pass across 22 test files after all phases (Phase 7 end state)
- `npm start` → tools/list shows same 5 tools with unchanged schemas
- Task 8.0 — Implement ReviewRequest and Manual Export Provider ✅
@@ -135,7 +137,7 @@ Project-local Claude Code discovery configured:
- Defaults to `"openai"` when not set — OpenAI behaviour unchanged
**Tests:** 56 new tests in `test/providers/manual-export.test.js` + 9 new in `test/providers/factory.test.js`
- Total: 644 passing tests across 21 test files, zero regressions
- Total: 706 passing tests across 22 test files, zero regressions
- `.claude/` added to `.gitignore` (no machine-specific paths committed)
- Task 9.1 — Ollama Provider Implementation ✅
@@ -173,10 +175,24 @@ Three providers now supported: `openai`, `manual`, `ollama`.
- Provider selection via `CHATGPT_MCP_PROVIDER` environment variable
- Zero additional dependencies — Ollama provider uses native `fetch()` only
## Next Pending
- README.md updated with Setup, MCP Tools, and Running sections
- MCP config snippet uses `"command": "npm"`, `"args": ["start"]` — no absolute paths
- All 5 tools documented in README
## V1 Milestone Complete
**Status: V1 Complete** — all planned phases implemented and tested.
### Summary
- 3 supported providers: `openai`, `manual`, `ollama`
- 5 MCP tools registered with shared schema
- Interactive setup helper (`npm run setup`)
- Provider abstraction layer with factory pattern
- Comprehensive test suite: 706 tests across 22 files
- Full documentation consistent and release-ready
### Future Work (Low Priority)
- Anthropic provider adapter
- Streaming responses
- Response caching
- Cost tracking per tool call
- Dockerfile / CI pipeline
## Phase 3 Completion Summary
@@ -212,6 +228,8 @@ All five tool handlers are implemented and tested:
| 4 | `handleDebugIssue` | `src/tools/debug-issue.js` | ✅ 28 |
| 5 | `handleArchitectureReview` | `src/tools/architecture-review.js` | ✅ 28 |
Total: 139 orchestration-only tests, all passing.
**What Phase 4 established:**
- Five standalone, dependency-injected handlers following the same orchestration pattern: validate → config → budget → prompt → client → response.
@@ -240,11 +258,26 @@ Provider abstraction layer decouples tool handlers from OpenAI implementation:
## Phase 7 Completion Summary — Tests ✅
All tests rewritten and verified:
- 644 passing tests across 21 test files (Phase 8 added 65 tests; Phase 9 has no new tests yet)
- 706 passing tests across 22 test files (Phase 8 added 65 tests; Phase 9 added context-loading tests; Task 10.3 added 38 tests)
- Provider/config tests in factory.test.js, openai.test.js, env.test.js, manual-export.test.js
- All handler tests use `{ loadConfig, createProvider }` mock pattern
- `npm start` → tools/list shows identical 5 tools with unchanged schemas
## Next Pending
## V1 Milestone Complete
No pending tasks. MVP is complete. Future work roadmap: Anthropic provider, streaming responses, response caching, structured output parsing, cost tracking per tool call.
**Status: V1 Complete** — all planned phases implemented and tested.
### Summary
- 3 supported providers: `openai`, `manual`, `ollama`
- 5 MCP tools registered with shared schema
- Interactive setup helper (`npm run setup`)
- Provider abstraction layer with factory pattern
- Comprehensive test suite: 706 tests across 22 files
- Full documentation consistent and release-ready
### Future Work (Low Priority)
- Anthropic provider adapter
- Streaming responses
- Response caching
- Cost tracking per tool call
- Dockerfile / CI pipeline