alphagov / alphagov/tech-docs-gem

Add automated accessibility tests

Open
#149 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

accessibility CI/CD Automated checks
Dominant language
Ruby
Stars
16
Forks
47
Avg merge
1d 21h
Merged PRs (30d)
14

Description

The accessibility team recommended setting up automated testing for accessibility. alphagov/govuk-frontend uses axe but there are other options like tenon

This would be useful for developing tech-docs-gem, but also for technical writers in each implementation of tech-docs-template.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the axe and tenon options linked in the issue, then map how automated accessibility testing could support tech-docs-gem and each technical-writer implementation of tech-docs-template. Done means agreeing on an approach and integrating automated checks that cover the generated technical documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
accessibility, testing
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.