Skip to content

AGENTS.md

Latest commit

 

History

History
40 lines (33 loc) · 1.56 KB

AGENTS.md

File metadata and controls

40 lines (33 loc) · 1.56 KB
Raw

Agent instructions

Plugin documentation

All new plugins must include at least one screenshot captured from the running BB application in a staged environment before handoff.

  • Start the normal BB application and use its full rendered UI. Seed the plugin's primary workflow with safe, deterministic local data.

  • Add the plugin to the capture definitions in scripts/capture-plugin-screenshots.mjs, including an assertion for the live surface and the data that must be visible. Run it with a seeded thread:

    BB_CAPTURE_PROJECT_ID=proj_... \
BB_CAPTURE_THREAD_ID=thr_... \
node scripts/capture-plugin-screenshots.mjs

  • The script must drive the real BB nav panel, settings page, thread action, host surface, or CLI-backed surface and write packages/<plugin>/assets/staged-preview.png.

  • For plugins without a frontend, capture the real settings, provider, host, or CLI surface where the plugin is used. Do not substitute image generation, hand-authored SVG/HTML mockups, diagrams, or placeholder artwork.

  • Add the PNG to the plugin README under ## Staged preview and describe the live surface and staged data shown.

  • If an expected live label or data assertion fails, fix the staging workflow; do not weaken the assertion to make an empty or broken screen pass.

Before handoff, verify the live capture and README links:

for readme in packages/*/README.md; do
  base=${readme%/README.md}
  test -f "$base/assets/staged-preview.png" || exit 1
done
file packages/*/assets/staged-preview.png | grep -q 'PNG image data'
git diff --check