Rewrite README.md: 12 skills, 4 extensions (incl. forgejo), install:local flow #94

New issue

Closed

opened 2026-08-27 23:59:07 +00:00 by david · 1 comment

david commented

2026-08-27 23:59:07 +00:00

Owner

Summary

Rewrite README.md to match the current repo state: 12 skills, 4 extensions including forgejo, the new one-command npm run install:local flow, and fix the stale "Not in the package" and layout sections.

Background

The README is stale: it says 11 skills (there are 12), lists forgejo as not in the package / WIP, and documents two manual install flows — other machines: pi install https://git.excelera.net/david/pi-extensions-and-skills@main (pi clones, runs npm install, registers); dev machine: manual npm install + pi install /abs/path (pi does not run npm install for local paths), updates via git pull + /reload. The new install:local script replaces/simplifies these.

Part of the npm run install:local feature (tracking issue #41). Per AGENTS.md this is a documentation-labeled change delivered within the feature's branch/PR.

Depends on: #95 (Update package.json: add install:local script and register forgejo extension) — for the 4-extension manifest counts; the flow itself is described from the script steps implemented in M2.

Implementation Details

Read the current README and cross-check the actual counts before writing: ls skills (expect 12) and node -e "console.log(require('./package.json').pi.extensions.length)".
Update:
- Skills: 12 — list them.
- Extensions: 4 incl. forgejo — extensions/rg/index.ts, extensions/postgres/index.ts, extensions/pr-comments/src/index.ts, extensions/forgejo/src/index.ts. Note: if the grillme extension has since been vendored and registered in the manifest (see the plan's out-of-scope note), state the actual registered count and list it — match the manifest at implementation time; do not hardcode "4" if it is 5.
- New flow: git clone https://git.excelera.net/david/pi-extensions-and-skills && cd pi-extensions-and-skills && npm run install:local — works from any checkout. Describe the steps in order (preflight → git pull → npm install → global pi registration with URL dedupe → /reload reminder) and the fail-fast behavior (aborts with an actionable message when something is missing).
- Fix stale sections: remove or correct the "Not in the package" section (forgejo is no longer "not in the package") and fix the layout section.
Keep any other accurate content intact.

Acceptance Criteria

README states 12 skills and lists them.
README documents npm run install:local: the one-command clone→install flow, its steps in order, and the verification after /reload (12 skills, 4 extensions incl. forgejo).
README states an extension count matching the actual manifest at implementation time (4 incl. forgejo, or 5 if grillme is registered — verified, not assumed).
The stale "Not in the package" section is removed or corrected (forgejo is no longer listed as not in the package / WIP).
No leftover references to outdated layout or to the old counts (e.g. "11 skills").
All internal links/anchors in the README resolve.

Test Plan

Cross-check counts: ls skills | wc -l (= 12) and node -e "console.log(require('./package.json').pi.extensions.length)".
Read the rendered README end-to-end; verify every in-repo link target exists.
Grep for stale phrases (Not in the package, 11 skills) → none remain.

## Summary Rewrite README.md to match the current repo state: 12 skills, 4 extensions including forgejo, the new one-command `npm run install:local` flow, and fix the stale "Not in the package" and layout sections. ## Background The README is stale: it says 11 skills (there are 12), lists forgejo as not in the package / WIP, and documents two manual install flows — other machines: `pi install https://git.excelera.net/david/pi-extensions-and-skills@main` (pi clones, runs npm install, registers); dev machine: manual `npm install` + `pi install /abs/path` (pi does not run npm install for local paths), updates via `git pull` + `/reload`. The new `install:local` script replaces/simplifies these. Part of the `npm run install:local` feature (tracking issue #41). Per AGENTS.md this is a `documentation`-labeled change delivered within the feature's branch/PR. **Depends on:** #95 (Update package.json: add install:local script and register forgejo extension) — for the 4-extension manifest counts; the flow itself is described from the script steps implemented in M2. ## Implementation Details - Read the current README and cross-check the actual counts before writing: `ls skills` (expect 12) and `node -e "console.log(require('./package.json').pi.extensions.length)"`. - Update: - **Skills**: 12 — list them. - **Extensions**: 4 incl. forgejo — `extensions/rg/index.ts`, `extensions/postgres/index.ts`, `extensions/pr-comments/src/index.ts`, `extensions/forgejo/src/index.ts`. Note: if the grillme extension has since been vendored and registered in the manifest (see the plan's out-of-scope note), state the actual registered count and list it — match the manifest at implementation time; do not hardcode "4" if it is 5. - **New flow**: `git clone https://git.excelera.net/david/pi-extensions-and-skills && cd pi-extensions-and-skills && npm run install:local` — works from any checkout. Describe the steps in order (preflight → `git pull` → `npm install` → global pi registration with URL dedupe → `/reload` reminder) and the fail-fast behavior (aborts with an actionable message when something is missing). - **Fix stale sections**: remove or correct the "Not in the package" section (forgejo is no longer "not in the package") and fix the layout section. - Keep any other accurate content intact. ## Acceptance Criteria - [ ] README states 12 skills and lists them. - [ ] README documents `npm run install:local`: the one-command clone→install flow, its steps in order, and the verification after `/reload` (12 skills, 4 extensions incl. forgejo). - [ ] README states an extension count matching the actual manifest at implementation time (4 incl. forgejo, or 5 if grillme is registered — verified, not assumed). - [ ] The stale "Not in the package" section is removed or corrected (forgejo is no longer listed as not in the package / WIP). - [ ] No leftover references to outdated layout or to the old counts (e.g. "11 skills"). - [ ] All internal links/anchors in the README resolve. ## Test Plan - Cross-check counts: `ls skills | wc -l` (= 12) and `node -e "console.log(require('./package.json').pi.extensions.length)"`. - Read the rendered README end-to-end; verify every in-repo link target exists. - Grep for stale phrases (`Not in the package`, `11 skills`) → none remain.

david added this to the M4 - Documentation milestone

2026-08-27 23:59:07 +00:00

david added the

documentation

label

2026-08-27 23:59:07 +00:00

david commented

2026-09-18 04:29:10 +00:00

Author

Owner

Closing — verified complete on main (landed incrementally via #47/#48 removing the stale "Not in the package" section, #54/#55 renaming to install:local, and subsequent count updates).

Acceptance criteria check against current main:

✅ README states the skill count and lists them — now 15 (repo grew past the 12 assumed when this issue was written; per the issue's own guidance, match reality at implementation time)
✅ npm run install:local documented with steps in order (preflight → git pull → npm install → global registration with URL dedupe → /reload reminder), fail-fast behavior, and post-/reload verification
✅ All 10 extensions listed in "Extension notes", incl. forgejo — matches the manifest in package.json (verified)
✅ Stale "Not in the package" section removed (6a1f590, issue-47)
✅ No leftover "11 skills" or stale layout references (grep clean)
✅ All 8 in-repo link targets resolve

Closing — verified complete on main (landed incrementally via #47/#48 removing the stale "Not in the package" section, #54/#55 renaming to `install:local`, and subsequent count updates). Acceptance criteria check against current main: - ✅ README states the skill count and lists them — now **15** (repo grew past the 12 assumed when this issue was written; per the issue's own guidance, match reality at implementation time) - ✅ `npm run install:local` documented with steps in order (preflight → `git pull` → `npm install` → global registration with URL dedupe → `/reload` reminder), fail-fast behavior, and post-`/reload` verification - ✅ All **10** extensions listed in "Extension notes", incl. forgejo — matches the manifest in `package.json` (verified) - ✅ Stale "Not in the package" section removed (`6a1f590`, issue-47) - ✅ No leftover "11 skills" or stale layout references (grep clean) - ✅ All 8 in-repo link targets resolve

david closed this issue

2026-09-18 04:29:12 +00:00