wagtail / wagtail/guide

Content that explains the User Bar & Accessibility Checker

Open
#303 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

Wagtail 4.2 introduced a new amazing feature, an accessibility checker built in to the Wagtail user bar.

Someone recently asked on Slack about how this feature worked and I searched on the Guide but saw that it is not yet documented there.

I think it would be great to see the user bar generally documented and a call out to the accessibility checker and how to use it.

Screenshot 2023-03-19 at 8 33 13 pm

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 4.2 accessibility-checker release note and the writing_templates.html section on the wagtailuserbar tag. Review the Guide's Concepts and How-to Guides sections to decide where the User Bar, accessibility checker, and preview guidance belong. Done means the Guide explains how the User Bar and checker work and how editors use them.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
Half a day
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.