plugin-guide-maintenance

Featured

Keep the Plugin Guide aligned with public Plugin SDK changes that affect its documented contract. Use this skill when an addition, change, rename, stabilization, or removal in @get-bb/plugin-sdk, app.slots.*, or BbPluginApi changes a Guide card, API symbol list, fixture, or SDK inventory. Do not use it for internal API work or interface-only changes that leave the Guide accurate.

AI & Automation 3,526 stars 455 forks Updated today MIT

Install

View on GitHub

Quality Score: 87/100

Stars 20%
100
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# Maintain the Plugin Guide for a public API change The Plugin Guide is bb's public Plugin SDK reference. Use this workflow only when a public API change affects its documented contract. ## Confirm the trigger Build the declarations and inspect the SDK change: ```sh pnpm exec turbo run build:types --filter=@get-bb/plugin-sdk git diff -- packages/plugin-sdk/package.json packages/plugin-sdk/src ``` Continue only when the API change affects a Guide card, API symbol list, fixture, or SDK inventory. If the Guide remains accurate, do not change it. New public members also require: - an `experimental_` name, or an `Experimental` type name; - an entry in `docs/api_to_audit.md`; - compatibility with released SDK users unless the user approves the break. ## Find the product source For a visible method, inspect these sources: 1. The app component that shows the surface. 2. The slot, collector, or adapter that inserts the plugin content. 3. The closest app test that defines the real states. Record stable source paths and anchors in `packages/plugin-api-map/src/anatomy-manifest.json`. Use labels, roles, data attributes, class constants, and state names as anchors. For a method without a visible surface, use the Plugin backend group. Do not invent interface elements. ## Add the Guide entry For a new Guide entry, run the scaffold command with its sources and symbols: ```sh pnpm exec turbo run scaffold:surface-entry --filter=@bb/plugin-api-map -- \ --id <stable-id> \ --tit...

Details

Author
get-bb
Repository
get-bb/bb
Created
6 months ago
Last Updated
today
Language
TypeScript
License
MIT

Similar Skills

Semantically similar based on skill content — not just same category