Add user instructions to goon plugin UI #7

Merged
kfj001 merged 3 commits from feature/goon-instructions into master 2026-08-30 21:27:53 -07:00
Member

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

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.
# 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.
robot added 2 commits 2026-08-30 20:27:27 -07:00
robot requested review from kfj001 2026-08-30 20:29:51 -07:00
Author
Member

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

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
robot left a comment
Author
Member

QA approved: instructions panel, accessibility, and smoke tests passed in local verification. Environment: 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
kfj001 added 1 commit 2026-08-30 21:22:16 -07:00
Slight copy update
CI / test (pull_request) Successful in 5m32s
41723227c0
kfj001 approved these changes 2026-08-30 21:24:36 -07:00
kfj001 left a comment
Owner

👍

👍
kfj001 scheduled this pull request to auto merge when all checks succeed 2026-08-30 21:26:34 -07:00
kfj001 merged commit 0848cd51be into master 2026-08-30 21:27:53 -07:00
kfj001 deleted branch feature/goon-instructions 2026-08-30 21:27:53 -07:00
Sign in to join this conversation.
No Reviewers
No labels
2 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: WesternTechnologies/goon_plugin#7