Skip to content

docs: add documentation for audio description feature in video options#11

Merged
abhalsod-sonata merged 2 commits into
masterfrom
feat/TNL2-587
Apr 22, 2026
Merged

docs: add documentation for audio description feature in video options#11
abhalsod-sonata merged 2 commits into
masterfrom
feat/TNL2-587

Conversation

@abhalsod-sonata
Copy link
Copy Markdown

@abhalsod-sonata abhalsod-sonata commented Apr 17, 2026

Description

Add author-facing documentation for the new Audio Description (AD) feature in the Studio video editor, supporting WCAG 2.1 SC 1.2.5.

This PR adds a new "Audio Description" section to en_us/shared/video/additional_video_options.rst covering:

  • Overview of audio description and its accessibility purpose
  • Supported file formats (MP3, OGG, M4A, WAV, AAC) and 200 MB size limit
  • Step-by-step instructions for adding, replacing, and deleting audio description files from the Studio video editor
  • Error states: unsupported file type and file size exceeded
  • Collapsed section states (with and without an uploaded file)
  • LMS video player toggle button states: active, inactive, and disabled (with tooltip)
  • Screenshots for each step and state

Related PRs:

Jira

Reviewers

Possible roles follow. The PR submitter checks the boxes after each reviewer finishes and gives 👍.

  • Subject matter expert:
  • Product review:
  • Partner support:
  • PM review:

Testing

  • Ran ./run_tests.sh without warnings or errors

@abhalsod-sonata abhalsod-sonata changed the title feat: add audio description feature for video components docs: add documentation for audio description feature in video options Apr 17, 2026
@cablaa77
Copy link
Copy Markdown

looks good to me. A couple of minor suggestions:

  • Would be nice to have a screenshot of toggle button after line 171
  • Capitalize the U in Unit in line 192
  • Capitalize the U in Unit in line 309

@abhalsod-sonata abhalsod-sonata merged commit 44b6141 into master Apr 22, 2026
1 check passed
@abhalsod-sonata abhalsod-sonata deleted the feat/TNL2-587 branch April 22, 2026 08:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants