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.
Confirm the instructions banner renders expanded on mount.
Click the toggle and confirm the panel collapses / expands and the label changes.
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.
# 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.
QA verified the new instructions panel in the VidPlex popup.
Pass:
- Copy matches the PR description: Quick start, 4-step flow, warning, and learn-more note.
- Placement/layout: panel is visible above the primary action button and renders cleanly in the popup-sized viewport.
- Responsiveness: no clipping observed at the tested popup width; panel and controls remain usable.
- Accessibility: the instructions panel is a labeled region, the toggle exposes aria-expanded, and keyboard focus/Enter toggles collapse/expand.
- Smoke tests: npm run build ✅, npm test ✅ (after build generated dist/hlds.js).
Notes:
- I did not observe any console errors in the UI flow beyond a blank jsdom/browser tooling artifact from the browser harness.
- The warning copy is visible in the panel and matches the stated failure mode (pages/extension pages/restricted frames can hide videos).
Environment used: local build at http://127.0.0.1:4173/viewer/index.html
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
Add user instructions to goon plugin UI
Branch:
feature/goon-instructionsSummary
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
Testing
npm run buildnpm testManual verification:
Changed files
src/viewer/index.htmlsrc/viewer/index.csssrc/viewer/index.js__tests__/instructions_ui.test.mjs__tests__/run.mjsdocs/instructions-audit.mddocs/instructions-design.mddocs/instructions-copy.mddocs/instructions-demo.svgAcceptance criteria
master.Open questions / risks
QA verified the new instructions panel in the VidPlex popup.
Pass:
Notes:
Environment used: local build at http://127.0.0.1:4173/viewer/index.html
QA approved: instructions panel, accessibility, and smoke tests passed in local verification. Environment: http://127.0.0.1:4173/viewer/index.html
👍