Skip to content

feat: complete improvement plans 001-013 (cli features, docs expansion, distribution spike) - #4

Merged
jal-co merged 4 commits into
mainfrom
feat/complete-improvement-plans
Jul 1, 2026
Merged

feat: complete improvement plans 001-013 (cli features, docs expansion, distribution spike)#4
jal-co merged 4 commits into
mainfrom
feat/complete-improvement-plans

Conversation

@jal-co

@jal-co jal-co commented Jul 1, 2026

Copy link
Copy Markdown
Owner

What

Executes all 13 improvement plans in plans/ (008 superseded by 012):

SDK CLI (@jalco/ap-sdk)

  • ap-sdk init — scaffolds a working plugin.ts + .gitignore (dry-run, overwrite protection)
  • ap-sdk uninstall — backed by an install manifest written by install; removes only recorded files/entries, leaves foreign config intact
  • ap-sdk dev — watch mode with rebuild-on-change, error recovery, and optional --install
  • npm:<package>[@version] as a remote source for install/check, same compatibility gate as GitHub sources; --ref + npm rejected with a clear error

Docs site

  • Root README overhaul + new npm package README (both jnsahaj credits preserved)
  • Seven "Define" feature pages (skills, commands, subagents, hooks, MCP, tools, instructions-and-files)
  • Porting reframed as a harness-neutral hub with per-source subpages matching exactly what src/port.ts detects
  • Generated API reference (pnpm --filter @jal-co/docs generate:api, runs on prebuild)
  • ⌘K search dialog on fumadocs-core's useDocsSearch, prev/next pagination, edit-this-page links
  • Callout + Tabs MDX components, mobile TOC + AI copy row below xl, dead floating navbar variant removed
  • /docs/plugins registry driven by the ap-sdk-plugin GitHub topic + npm keyword (filter, channel filter, three sorts, degraded/empty states, hourly ISR)

Distribution spike (plan 007)

  • plans/007-artifacts/: design doc with transcripts, reference template tree (passes ap-sdk check), draft composite action (BLOCKED-ON marker for the proposed --fail-on-warnings flag)

Why

Executes the growth-focused improvement plans generated at commit fe6fb92 — features, DX, docs, and distribution. See plans/README.md for the full index and dependency notes.

How

  • All four CLI plans share src/cli.ts and were done serially on one branch
  • Registry fetcher merges GitHub topic search + npm keyword search with Promise.allSettled; one source failing still renders the other, both failing → degraded state
  • API reference generation is a repo-local script (evaluated fumadocs-typescript/TypeDoc first; decision recorded in plans/009-artifacts/decision.md)
  • Five .tegami/ changelogs: 4 minor (init, uninstall, dev, npm source) + 1 patch (package README)

Testing

  • pnpm turbo typecheck test lint build — all green (147 tests, 26 files)
  • Template plugin.ts passes ap-sdk check; action.yml parses as YAML
  • Remote check smoke: ap-sdk check https://github.com/jal-co/agent-plugin-sdk --path packages/agent-plugin-sdk/examples/git-helper → compatible
  • Docs build generates all routes including /docs/plugins (empty state) and the API reference

Tour (large PR)

  1. plans/README.md — index + statuses
  2. packages/agent-plugin-sdk/src/{cli,scaffold-plugin,uninstall,dev,npm}.ts + matching tests
  3. apps/docs/content/docs/ — new pages + meta.json
  4. apps/docs/src/components/{search-dialog,docs-pagination,callout,tabs,plugin-directory}.tsx
  5. apps/docs/src/lib/github-plugins.ts, apps/docs/scripts/generate-api-docs.mjs
  6. plans/007-artifacts/, plans/009-artifacts/

Operator follow-ups (from plan 007/012)

  • Create jal-co/ap-sdk-plugin-template + jal-co/ap-sdk-action from the spike artifacts
  • Optionally tag this repo with the ap-sdk-plugin topic to seed the registry

jal-co added 4 commits July 1, 2026 16:42
Adds four CLI features from improvement plans 002/005/006/013:

- ap-sdk init scaffolds a working plugin.ts + .gitignore with dry-run
  and overwrite protection
- ap-sdk install records an install manifest; ap-sdk uninstall reverses
  only recorded files/entries and leaves foreign config intact
- ap-sdk dev watches the plugin dir, rebuilds on change, survives
  broken plugins, and optionally reinstalls with --install
- npm:<package>[@Version] as a remote source for install/check, with
  the same compatibility gate as GitHub sources

Docs: quickstart now leads with npx ap-sdk init; installing-plugins
gains a From npm section.
Fixes the broken Docs link, makes the Examples link absolute, adds a
'What you can define' feature table and an 'Already have a plugin?'
porting section, and gives the npm package a README with all-absolute
links. Both attribution credits preserved. (plan 001)
…ch + nav

Implements docs plans 003/004/009/010/011/012:

- seven Define pages (skills, commands, subagents, hooks, mcp, tools,
  instructions-and-files) wired into the sidebar
- porting reframed as a harness-neutral hub with per-source subpages
  matching exactly what src/port.ts detects
- generated API reference section (pnpm generate:api, runs on prebuild)
- search dialog (cmd-K) on fumadocs-core's useDocsSearch, prev/next
  pagination, and edit-this-page links
- Callout + Tabs MDX components, mobile TOC + AI copy row below xl,
  dead floating navbar variant removed
- /docs/plugins registry driven by the ap-sdk-plugin GitHub topic and
  npm keyword, with filter/sort/channel badges and degraded/empty states
Checks in the 13 improvement plans with statuses updated to DONE
(008 superseded by 012), plus plan 007's deliverables: the design doc,
reference template tree, and draft composite action, and plan 009's
tooling decision record.
@vercel

vercel Bot commented Jul 1, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
agent-plugin-sdk-docs Ready Ready Preview, Comment Jul 1, 2026 9:50pm

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Commit-Check ✔️

@jal-co
jal-co merged commit 7e241d6 into main Jul 1, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant