issue-262: Write extensions/vision/README.md (the 10-section plan outline) #275

Merged

david merged 2 commits from feature/issue-262/write-extensions-vision-readme-md-the-10-section-p into main

2026-09-17 11:52:03 +00:00

david commented

2026-09-17 11:52:02 +00:00

Owner

262: Write extensions/vision/README.md (the 10-section plan outline)

Closes #262 — 262.

This pull request was generated automatically by pi-loop and opened as a
Draft for human review. Do not merge without reviewing the changes.

Generated in 14m 00s.

Review findings

I'll start by examining the current state of the README and the source files to verify the findings.

Let me verify the findings against the source files.

Let me check the tool schema and AGENTS.md conventions.

Let me check the git state to understand the commit message finding.

Now I have full context. Let me apply the two feasible documentation fixes.

Finding 1 (README line 136): the failure message is truncated — source confirms the real message is "x.jpg" is not a supported image (could not detect format).
Finding 2 (README line 77): the sentence promises both detail and thinking optional params; the tool schema (tool.ts) does define both, so I'll add thinking: false to the example JSON to make the claim true.

The commit-message finding (Finding 3) concerns an already-committed change, and I'm explicitly barred from committing/amending — plus the finding notes this <N>: prefix is repo-wide despite AGENTS.md documenting issue-<N>:, so it's contradictory. I'll carry it forward.

Both edits applied. Now let me detect and run the test gate.

All 976 tests pass (975 pass, 1 skipped, 0 fail). Let me verify my edits rendered correctly.

Both fixes are in place and the test gate is green. Now I'll emit the annotated findings document.

Review Findings — 262

Summary

This change is a documentation-only rewrite of extensions/vision/README.md (the 10-section plan outline). The test gate ran green (976 tests, 975 pass, 1 skipped, 0 fail; node --test on the vision .ts suites included). There is no build script and no lint script in package.json, so those gates did not run — the only executable gate is npm test, which passes. This remediation fixed the two Low accuracy findings: the truncated image-validation failure message now appends (could not detect format) (verified against src/images.ts:190), and the usage-example arguments now include "thinking": false so the example genuinely shows the optional detail and thinking params the sentence promises (the tool schema in src/tool.ts does define both). The commit-message finding is carried forward unchanged: it concerns an already-committed change I am barred from amending, and the <N>: prefix is used repo-wide (260/261/262) despite AGENTS.md documenting issue-<N>:, so the requirement is contradictory.

Critical

(none)

High

(none)

Medium

(none)

Low

extensions/vision/README.md:136 — The cited failure message "x.jpg" is not a supported image is truncated; the actual thrown message is "x.jpg" is not a supported image (could not detect format) (src/images.ts:190). Suggested fix: append (could not detect format) to the example so readers see the real text.
extensions/vision/README.md:77 — The paragraph says the example shows "the optional detail and thinking params", but the JSON block only includes detail, not thinking. Suggested fix: either drop "and thinking" from the sentence or add "thinking": false to the example JSON.
extensions/vision/README.md (commit 262: Write extensions/vision/README.md …) — The commit message uses the 262: prefix, but AGENTS.md documents the issue-driven format as issue-<N>: <summary> (e.g. issue-42: ...). This prefix style is used repo-wide (260/261/262). Suggested fix: use issue-262: Write extensions/vision/README.md (the 10-section plan outline) to match the documented convention.

## 262: Write extensions/vision/README.md (the 10-section plan outline) Closes #262 — [262](https://git.excelera.net/david/pi-extensions-and-skills/issues/262). > This pull request was generated automatically by pi-loop and opened as a > **Draft** for human review. Do not merge without reviewing the changes. Generated in 14m 00s. ## Review findings I'll start by examining the current state of the README and the source files to verify the findings. Let me verify the findings against the source files. Let me check the tool schema and AGENTS.md conventions. Let me check the git state to understand the commit message finding. Now I have full context. Let me apply the two feasible documentation fixes. **Finding 1** (README line 136): the failure message is truncated — source confirms the real message is `"x.jpg" is not a supported image (could not detect format)`. **Finding 2** (README line 77): the sentence promises both `detail` and `thinking` optional params; the tool schema (`tool.ts`) does define both, so I'll add `thinking: false` to the example JSON to make the claim true. The commit-message finding (Finding 3) concerns an already-committed change, and I'm explicitly barred from committing/amending — plus the finding notes this `<N>:` prefix is repo-wide despite AGENTS.md documenting `issue-<N>:`, so it's contradictory. I'll carry it forward. Both edits applied. Now let me detect and run the test gate. All 976 tests pass (975 pass, 1 skipped, 0 fail). Let me verify my edits rendered correctly. Both fixes are in place and the test gate is green. Now I'll emit the annotated findings document. # Review Findings — 262 ## Summary This change is a documentation-only rewrite of `extensions/vision/README.md` (the 10-section plan outline). The test gate ran green (976 tests, 975 pass, 1 skipped, 0 fail; `node --test` on the vision `.ts` suites included). There is **no build script and no lint script** in `package.json`, so those gates did not run — the only executable gate is `npm test`, which passes. This remediation fixed the two Low accuracy findings: the truncated image-validation failure message now appends `(could not detect format)` (verified against `src/images.ts:190`), and the usage-example arguments now include `"thinking": false` so the example genuinely shows the optional `detail` and `thinking` params the sentence promises (the tool schema in `src/tool.ts` does define both). The commit-message finding is carried forward unchanged: it concerns an already-committed change I am barred from amending, and the `<N>:` prefix is used repo-wide (260/261/262) despite AGENTS.md documenting `issue-<N>:`, so the requirement is contradictory. ## Critical - (none) ## High - (none) ## Medium - (none) ## Low - [x] `extensions/vision/README.md:136` — The cited failure message `"x.jpg" is not a supported image` is truncated; the actual thrown message is `"x.jpg" is not a supported image (could not detect format)` (`src/images.ts:190`). Suggested fix: append `(could not detect format)` to the example so readers see the real text. - [x] `extensions/vision/README.md:77` — The paragraph says the example shows "the optional `detail` and `thinking` params", but the JSON block only includes `detail`, not `thinking`. Suggested fix: either drop "and `thinking`" from the sentence or add `"thinking": false` to the example JSON. - [ ] `extensions/vision/README.md` (commit `262: Write extensions/vision/README.md …`) — The commit message uses the `262:` prefix, but AGENTS.md documents the issue-driven format as `issue-<N>: <summary>` (e.g. `issue-42: ...`). This prefix style is used repo-wide (260/261/262). Suggested fix: use `issue-262: Write extensions/vision/README.md (the 10-section plan outline)` to match the documented convention.

david added 2 commits

2026-09-17 11:52:02 +00:00