warriordog/mooltipage

Docs: Support reader mode, screen readers, and other assistive tech

Open

#50 opened on Oct 4, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)TypeScript (4 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (PR metrics pending)

Description

  • Support reader mode in main browsers (Chrome / FF at a minimum, preferably Safari and Edge too)
  • Validate and correct (if needed) usage of HTML5 semantic tags in all parts of the documentation
  • Add aria tags / related accessibility HTML features

EDIT: Adding "good first issue" tag because this requires no knowledge of Mooltipage to complete. It could, however, require advanced knowledge of HTML so keep that in mind if you consider working this issue.

Contributor guide

Research direction
Review the documentation for proper use of HTML5 semantic tags and ARIA attributes to ensure compatibility with screen readers and reader mode.
Tech stack
html
Domain
documentationaccessibility
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
HTML
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80