Skip to content

Commit 6e50cd4

Browse files
committed
docs: fix global refiner command references
1 parent f2df094 commit 6e50cd4

6 files changed

Lines changed: 79 additions & 4 deletions

File tree

.planning/STATE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,12 @@
2727
### Blockers
2828
- None.
2929

30+
### Quick Tasks Completed
31+
32+
| # | Description | Date | Commit | Status | Directory |
33+
|---|-------------|------|--------|--------|-----------|
34+
| 260610-pps | Fix PR #1 review blocker: README and build_and_install.ps1 must accurately document the globally exposed gemini-prompt-refiner command | 2026-06-10 | this commit | Verified | [260610-pps-fix-pr-1-review-blocker-readme-and-build](./quick/260610-pps-fix-pr-1-review-blocker-readme-and-build/) |
35+
3036
## Session Continuity
37+
Last activity: 2026-06-10 - Completed quick task 260610-pps: Fix PR #1 command documentation blocker.
3138
The project is set up with a clear 3-phase roadmap. Next step is to begin planning Phase 1.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
quick_id: 260610-pps
3+
status: ready
4+
mode: quick-full
5+
description: "Fix PR #1 review blocker: README and build_and_install.ps1 must accurately document the globally exposed gemini-prompt-refiner command"
6+
---
7+
8+
# Quick Task 260610-pps Plan
9+
10+
## Goal
11+
12+
Make the root README and install script accurately identify the global executable exposed by `universal-refiner/package.json`.
13+
14+
## Must Haves
15+
16+
- `README.md` tells users to configure `gemini-prompt-refiner`, matching the package manifest's `bin` key.
17+
- `build_and_install.ps1` reports and recommends `gemini-prompt-refiner` after global installation.
18+
- The task remains documentation-only and does not alter package behavior.
19+
20+
## Tasks
21+
22+
1. Update inaccurate `prompt-refiner` command references in `README.md` and `build_and_install.ps1`.
23+
2. Verify the package manifest and both user-facing files agree on `gemini-prompt-refiner`.
24+
3. Run `git diff --check`, record validation evidence, update GSD state, and commit the complete quick task atomically.
25+
26+
## Validation
27+
28+
- Inspect `universal-refiner/package.json` and confirm `bin` contains `gemini-prompt-refiner`.
29+
- Search `README.md` and `build_and_install.ps1` for command references and confirm no inaccurate `prompt-refiner` executable remains.
30+
- Run `git diff --check`.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
quick_id: 260610-pps
3+
status: complete
4+
completed: 2026-06-10
5+
---
6+
7+
# Quick Task 260610-pps Summary
8+
9+
Updated every user-facing executable reference in `README.md` and `build_and_install.ps1` to `gemini-prompt-refiner`, matching the sole `bin` key in `universal-refiner/package.json`.
10+
11+
## Changes
12+
13+
- Corrected the README architecture label and MCP client configuration instruction.
14+
- Corrected the install script's success and usage messages.
15+
- Left package behavior unchanged.
16+
17+
## Validation
18+
19+
- Parsed `universal-refiner/package.json` and confirmed `bin=gemini-prompt-refiner`.
20+
- Inspected all `prompt-refiner` references in `README.md` and `build_and_install.ps1`.
21+
- Ran `git diff --check`.
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
quick_id: 260610-pps
3+
status: passed
4+
verified: 2026-06-10
5+
---
6+
7+
# Quick Task 260610-pps Verification
8+
9+
## Result
10+
11+
Passed. `README.md` and `build_and_install.ps1` consistently identify `gemini-prompt-refiner` as the globally exposed command defined by `universal-refiner/package.json`.
12+
13+
## Evidence
14+
15+
- Manifest inspection found exactly one `bin` key: `gemini-prompt-refiner`.
16+
- Targeted inspection found no standalone stale `prompt-refiner` command references in the blocked files.
17+
- `git diff --check` completed without errors.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ That distinction matters because this repo is about credible system direction, n
4242

4343
```mermaid
4444
flowchart LR
45-
CLI["AI CLI\n(Claude / Cursor)"] -->|"stdio"| PI["PromptImprover\n(prompt-refiner)"]
45+
CLI["AI CLI\n(Claude / Cursor)"] -->|"stdio"| PI["PromptImprover\n(gemini-prompt-refiner)"]
4646
subgraph internal["PromptImprover Engine"]
4747
RAG["RAG Snippets\n(FlexSearch)"]
4848
Memory["SQLite Memory\n(LocalBrain)"]
@@ -69,7 +69,7 @@ cd Promptimprover
6969
.\build_and_install.ps1
7070
```
7171

72-
Add `prompt-refiner` to your MCP client configuration. See the [Setup Guide](https://github.com/Coding-Autopilot-System/Promptimprover/wiki/Setup-Guide) for full configuration instructions.
72+
Add `gemini-prompt-refiner` to your MCP client configuration. See the [Setup Guide](https://github.com/Coding-Autopilot-System/Promptimprover/wiki/Setup-Guide) for full configuration instructions.
7373

7474
## License
7575

build_and_install.ps1

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@ npm install -g .
88
$package = Get-Content .\package.json | ConvertFrom-Json
99
$version = $package.version
1010

11-
Write-Host "Prompt Refiner v$version installed globally as 'prompt-refiner'" -ForegroundColor Green
12-
Write-Host "Use 'prompt-refiner' command in your MCP configurations." -ForegroundColor Yellow
11+
Write-Host "Prompt Refiner v$version installed globally as 'gemini-prompt-refiner'" -ForegroundColor Green
12+
Write-Host "Use 'gemini-prompt-refiner' command in your MCP configurations." -ForegroundColor Yellow

0 commit comments

Comments
 (0)