Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 18, 2025

This PR adds comprehensive documentation for the speak_text variable that allows developers to disable the Assembly Line's built-in screen reader functionality on a per-interview or organization-wide basis.

Changes Made

Added a new "Screen reader control" section to the magic variables documentation (docs/components/AssemblyLine/magic_variables.md) that includes:

  • Purpose explanation: The screen reader was added for people with low literacy and users on shared workstations or borrowed mobile devices, not primarily for blind users
  • Configuration options: How to set speak_text = False to disable the functionality
  • Per-interview examples: Code snippets showing how to disable in individual interviews
  • Organization-wide examples: How to configure globally via shared YAML files
  • Reference link: Points to official Docassemble documentation for additional context

Example Usage

Per-interview configuration:

---
mandatory: True
code: |
  speak_text = False
  # ... rest of your interview order
---

Organization-wide configuration:

---
code: |
  speak_text = False
---

The new documentation section is properly integrated with the existing table of contents and follows the same formatting patterns as other variable documentation.

Screen reader documentation section

Fixes #192.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: nonprofittechy <7645641+nonprofittechy@users.noreply.github.com>
Copilot AI changed the title [WIP] Document how to turn off the screen reader Document how to disable screen reader functionality using speak_text variable Sep 18, 2025
Copilot finished work on behalf of nonprofittechy September 18, 2025 17:46
@nonprofittechy nonprofittechy marked this pull request as ready for review September 18, 2025 18:58
@nonprofittechy nonprofittechy merged commit c265956 into main Sep 18, 2025
2 checks passed
@nonprofittechy nonprofittechy deleted the copilot/fix-192 branch September 18, 2025 18:58
BryceStevenWilley added a commit that referenced this pull request Sep 19, 2025
mandatory: True
code: |
speak_text = False
# ... rest of your interview order
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@BryceStevenWilley yep, confirming this was my mistake in the PR review

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.

Document how to turn off the screen reader

2 participants