wagtail / wagtail/guide

Tutorial: accessible content with Wagtail

Open
#396 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

content
Dominant language
Python
Stars
36
Forks
39
Avg merge
2d 5h
Merged PRs (30d)
3

Description

This comes from Wagtail’s ATAG audit as part of RFC 89. We need new content to meet:

B.4.2.3 Tutorial

The authoring tool provides a tutorial for an accessible authoring process that is specific to that authoring tool

And that would also help with:

B.4.2.1 Model Practice (WCAG)

A range of examples in the documentation (e.g. markup, screen shots of WYSIWYG editing-views) demonstrate accessible authoring practices (WCAG).


This would cover things all of Wagtail’s content authoring features that touch accessibility, as listed in part B of our ATAG audit. Here are examples:

  • Plain language
  • Headings
  • Links
  • Alt text
  • Captions and subtitles
  • Form fields (help text)
  • Lang attributes (known feature gap in Wagtail)

Contributor guide

Open the contributing guide

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 with the linked Wagtail ATAG audit, especially part B, and RFC 89 to understand the expected coverage. Done means adding tutorial content and examples for accessible authoring across the listed topics, including plain language, headings, links, alternative text, captions, form help text, and language attributes.

Written by the indexing model from the issue text.

Assessment

Tech stack
django, python
Domain
accessibility, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.