List the vision extension in the repo root README #263

New issue

Closed

opened 2026-09-17 03:35:09 +00:00 by david · 1 comment

david commented

2026-09-17 03:35:09 +00:00

Owner

Summary

List the vision extension in the repo root README.md: the extension table, the requirements/credentials section, and the dependency list, so the README's inventory of the package stays accurate.

Background

Depends on: #261, #262

The vision extension is shipped from this repo as part of the pi package, but until now it existed only as extensions/vision/ plus its manifest entry. The repo root README.md is the package's front door: it carries a per-extension table (| Extension | What it provides |), a "Requirements" list naming the credentials each extension needs, and an extension list with one-line descriptions and links to each extension's README.

This step is repo convention rather than a line item in the implementation plan: when the Penpot extension landed, listing it in the root README was tracked and shipped as its own change (#216, Closes #216). Skipping it would leave the README understating what the package provides.

The wording must match extensions/vision/README.md (previous step) — its requirements, its unconfigured behaviour, and the tool's one-line description.

Implementation Details

Edit the repo root README.md only. Three places need the new extension, following the existing entries' exact formatting:

Extension table near the top (the | Extension | What it provides | table listing grillme, victorialogs, mongodb, penpot, …): add a vision row. Description should match the tool's promptSnippet in spirit — e.g. "Read or analyze local image files with DeepSeek vision (vision), against deepseek-flash; needs DEEPSEEK_API_KEY in .env (zero tools registered when unconfigured)". Keep it one line and consistent with the sibling rows.
Requirements list (the bulleted "A reachable MongoDB instance…" block): add a bullet for the DeepSeek API key, mirroring the MongoDB bullet's phrasing — optionally note the extension registers no tools when unconfigured.
Extensions list near the bottom (the - **mongodb** — …; see [...](extensions/mongodb/README.md) list): add - **vision** — read/analyze local image files via DeepSeek deepseek-flash (vision); DEEPSEEK_API_KEYfrom.env, absent ⇒ no tool registered; see [extensions/vision/README.md](extensions/vision/README.md).

Also check the "install" prose that enumerates the hoisted runtime dependencies (pg, dotenv, pgpass, typebox, adm-zip, mongodb) and add image-size where that list appears, so the documented install doesn't drift from package.json.

Notes:

Do not restructure the README, reorder existing entries, or rewrap unrelated lines.
Use the same link style and dash conventions as neighbouring entries.

Acceptance Criteria

The root README's extension table has a vision row written in the same style as its siblings.
The requirements list mentions DEEPSEEK_API_KEY (and the unconfigured no-tool behaviour).
The extensions list has a vision entry linking to extensions/vision/README.md.
Any enumerated runtime-dependency list in the README includes image-size.
No existing entry is removed, reordered, or reworded.

Test Plan

cd /Users/david/Projects/pi-extensions-and-skills
grep -n "vision" README.md
grep -n "image-size" README.md

Expected: the vision row in the table, the requirements bullet, the extensions list entry, and image-size in the dependency enumeration.

npm test

Expected: unaffected by this documentation change and still green.

Manual review: read the three edited regions side by side with their neighbouring entries to confirm consistent formatting and links.

## Summary List the `vision` extension in the repo root `README.md`: the extension table, the requirements/credentials section, and the dependency list, so the README's inventory of the package stays accurate. ## Background **Depends on:** #261, #262 The `vision` extension is shipped from this repo as part of the pi package, but until now it existed only as `extensions/vision/` plus its manifest entry. The repo root `README.md` is the package's front door: it carries a per-extension table (`| Extension | What it provides |`), a "Requirements" list naming the credentials each extension needs, and an extension list with one-line descriptions and links to each extension's README. This step is repo convention rather than a line item in the implementation plan: when the Penpot extension landed, listing it in the root README was tracked and shipped as its own change (`#216`, `Closes #216`). Skipping it would leave the README understating what the package provides. The wording must match `extensions/vision/README.md` (previous step) — its requirements, its unconfigured behaviour, and the tool's one-line description. ## Implementation Details Edit the repo root `README.md` only. Three places need the new extension, following the existing entries' exact formatting: 1. **Extension table** near the top (the `| Extension | What it provides |` table listing `grillme`, `victorialogs`, `mongodb`, `penpot`, …): add a `vision` row. Description should match the tool's `promptSnippet` in spirit — e.g. *"Read or analyze local image files with DeepSeek vision (`vision`), against `deepseek-flash`; needs `DEEPSEEK_API_KEY` in `.env` (zero tools registered when unconfigured)"*. Keep it one line and consistent with the sibling rows. 2. **Requirements list** (the bulleted "A reachable MongoDB instance…" block): add a bullet for the DeepSeek API key, mirroring the MongoDB bullet's phrasing — optionally note the extension registers no tools when unconfigured. 3. **Extensions list** near the bottom (the `- **mongodb** — …; see [...](extensions/mongodb/README.md)` list): add `- **vision** — read/analyze local image files via DeepSeek `deepseek-flash` (`vision`); `DEEPSEEK_API_KEY` from `.env`, absent ⇒ no tool registered; see [`extensions/vision/README.md`](extensions/vision/README.md).` Also check the "install" prose that enumerates the hoisted runtime dependencies (`pg`, `dotenv`, `pgpass`, `typebox`, `adm-zip`, `mongodb`) and add `image-size` where that list appears, so the documented install doesn't drift from `package.json`. Notes: - Do not restructure the README, reorder existing entries, or rewrap unrelated lines. - Use the same link style and dash conventions as neighbouring entries. ## Acceptance Criteria - [ ] The root README's extension table has a `vision` row written in the same style as its siblings. - [ ] The requirements list mentions `DEEPSEEK_API_KEY` (and the unconfigured no-tool behaviour). - [ ] The extensions list has a `vision` entry linking to `extensions/vision/README.md`. - [ ] Any enumerated runtime-dependency list in the README includes `image-size`. - [ ] No existing entry is removed, reordered, or reworded. ## Test Plan ```bash cd /Users/david/Projects/pi-extensions-and-skills grep -n "vision" README.md grep -n "image-size" README.md ``` Expected: the `vision` row in the table, the requirements bullet, the extensions list entry, and `image-size` in the dependency enumeration. ```bash npm test ``` Expected: unaffected by this documentation change and still green. Manual review: read the three edited regions side by side with their neighbouring entries to confirm consistent formatting and links.

david added this to the Vision: M7 - Packaging and documentation milestone

2026-09-17 03:35:09 +00:00

david added the

feature

label

2026-09-17 03:35:09 +00:00

david self-assigned this

2026-09-17 03:35:09 +00:00

david referenced this issue from a pull request that will close it,

2026-09-17 12:01:13 +00:00

issue-263: List the vision extension in the repo root README #276

david closed this issue