Oliver/video-accessibility
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
video-accessibility/docs
History
Vadym Samoilenko 6559ccc1f9 feat(help): in-app role-based help guides + screenshot capture pipeline 
- Help.tsx: role tabs, TOC scroll-spy, search, lightbox, react-markdown renderer
- 7 markdown guides (global, client, linguist, reviewer, production, PM, admin)
  with explicit click/drag/keyboard annotations throughout
- Sidebar: Help button added at bottom of nav (all roles)
- App.tsx: /help route, no RoleGate
- frontend/public/help-screenshots/{role}/: directories ready for screenshots
- tools/capture-help-screenshots.ts: Playwright screenshot script
  - Clicks "Local login" toggle before filling credentials
  - Uses test-admin local account (not SSO)
- backend/scripts/seed_test_users.py: idempotent MongoDB seed script
  creates 6 local-auth users (admin + 5 roles) for capture + local dev
- .env.screenshots.example: template with test-admin credentials
- Removes docs/video_accessibility_user_guide_v3.md (superseded by in-app guides)
- Deps: react-markdown, remark-gfm, rehype-raw added to frontend

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
2026-05-01 13:08:13 +01:00
..
project feat(help): in-app role-based help guides + screenshot capture pipeline 2026-05-01 13:08:13 +01:00
reference docs: add canonical documentation + audit cleanup 2026-04-29 14:22:51 +01:00
tasks docs: add canonical documentation + audit cleanup 2026-04-29 14:22:51 +01:00
documentation_standards.md docs: add canonical documentation + audit cleanup 2026-04-29 14:22:51 +01:00
principles.md docs: add canonical documentation + audit cleanup 2026-04-29 14:22:51 +01:00
prompt_closed_captions.md wrote docker files and deployment instructions 2025-10-08 16:00:12 -05:00
README.md docs: add canonical documentation + audit cleanup 2026-04-29 14:22:51 +01:00
Video Accessibility app Technical Documentation 2025-08-24.pdf initial commit 2025-08-24 16:28:33 -05:00
video accessibility demo user guide instructions.pdf fixed session refresh and added full deploy script - and added documentation including videos 2025-10-08 22:29:08 -05:00
video accessibility technical documentation 2025-09-09.pdf added MSAL microsoft authentication 2025-10-10 09:19:39 -05:00
video-accessibility-demo-instructions.mp4 fixed session refresh and added full deploy script - and added documentation including videos 2025-10-08 22:29:08 -05:00
video-accessibility-download-final-assets.mp4 fixed session refresh and added full deploy script - and added documentation including videos 2025-10-08 22:29:08 -05:00
video_accessibility_app_demo_2025-08-24.mp4 removed mongodb change stream monitoring, added global websockets monitoring for notifications, broke symmetry between toasts and persistent notifications (and refined which notifications get sent and how) 2025-08-25 15:48:18 -05:00
video_accessibility_spec.md wrote docker files and deployment instructions 2025-10-08 16:00:12 -05:00
video_accessibility_technical_docs_2025-08-24.md initial commit 2025-08-24 16:28:33 -05:00
video_accessibility_technical_documentation_v2.md added MSAL microsoft authentication 2025-10-10 09:19:39 -05:00

README.md

Documentation Hub — Accessible Video Processing Platform

This is the central index for all project documentation. Each section links to a specific domain doc.

Project Documentation

Document Contents
requirements.md Functional requirements, QC workflow, RBAC matrix
architecture.md System design, job state machine, data flow, security model
tech_stack.md All dependency versions, configuration anchors
api_spec.md REST endpoints, WebSocket, auth flows
database_schema.md MongoDB collections, indexes, data shapes
infrastructure.md Server inventory, ports, GCS layout, external services
runbook.md Local setup, deploy, restart, backup, rollback

Reference Documentation

Directory Contains
reference/README.md Index of ADRs, guides, manuals, research
reference/adrs/ Architecture Decision Records
reference/guides/ Developer how-to guides
reference/manuals/ Operator manuals
reference/research/ Technology research notes

Standards and Principles

Document Contents
documentation_standards.md 60 universal documentation requirements
principles.md 11 development principles (Standards First, YAGNI, KISS, DRY…)

Task and Test Management

Document Contents
tasks/README.md Task management rules and conventions
tests/README.md Test strategy, commands, coverage targets

Canonical Entry Point

All documentation is reachable from ../AGENTS.md. Agents and humans should start there.

Maintenance

Update triggers: New doc added, section moved, external URL changes. Verification: All links in this file resolve. AGENTS.md Quick Navigation matches this hub.