diff --git a/docs/pr-description.md b/docs/pr-description.md new file mode 100644 index 0000000..28f5da4 --- /dev/null +++ b/docs/pr-description.md @@ -0,0 +1,42 @@ +# Add user instructions to goon plugin UI + +Branch: `feature/goon-instructions` + +## Summary +Adds an always-visible, collapsible quick-start panel to the VidPlex popup so users can understand the scan / review / open / clear flow without reading the README first. + +## Links +- Audit notes: [docs/instructions-audit.md](docs/instructions-audit.md) +- Design notes: [docs/instructions-design.md](docs/instructions-design.md) +- Copy deck: [docs/instructions-copy.md](docs/instructions-copy.md) +- Preview render: [docs/instructions-demo.svg](docs/instructions-demo.svg) + +## Testing +- `npm run build` +- `npm test` + +Manual verification: +1. Open the extension popup. +2. Confirm the instructions banner renders expanded on mount. +3. Click the toggle and confirm the panel collapses / expands and the label changes. +4. Confirm the main Scan Videos button still works normally. + +## Changed files +- `src/viewer/index.html` +- `src/viewer/index.css` +- `src/viewer/index.js` +- `__tests__/instructions_ui.test.mjs` +- `__tests__/run.mjs` +- `docs/instructions-audit.md` +- `docs/instructions-design.md` +- `docs/instructions-copy.md` +- `docs/instructions-demo.svg` + +## Acceptance criteria +- A PR exists against `master`. +- The PR description includes summary, links to the design/copy docs, a visual preview, testing steps, changed files, and acceptance criteria. +- Reviewers are requested before handoff. + +## Open questions / risks +- The repo still has some pre-existing lint warnings outside this change. +- The preview asset is an SVG render of the UI rather than a raster screenshot.