Skip to content

Update a11y guidelines - #6361

Open
stevepiercy wants to merge 4 commits into
mainfrom
a11y-notes
Open

Update a11y guidelines#6361
stevepiercy wants to merge 4 commits into
mainfrom
a11y-notes

Conversation

@stevepiercy

@stevepiercy stevepiercy commented Oct 1, 2024

Copy link
Copy Markdown
Member

@plone/volto-accessibility please review.


📚 Documentation preview 📚: https://volto--6361.org.readthedocs.build/

Docs review/ updates to make

  • We should use https://volto.demo.plone.org for testing
  • Review tool recommendations
  • Discuss contrast
  • Discuss Screen-reader testing
  • Should we use "tap", "press", or "click" in language strings for that gesture across desktop and mobile devices?
  • How should we denote keystrokes in language strings across operating systems? For example, in MyST:
    {kbd}`Return`
    

@stevepiercy stevepiercy self-assigned this Oct 1, 2024
@netlify

netlify Bot commented Oct 1, 2024

Copy link
Copy Markdown

Deploy Preview for plone-components canceled.

Name Link
🔨 Latest commit efe2ce3
🔍 Latest deploy log https://app.netlify.com/sites/plone-components/deploys/67c4b9a9788905000874a9ed

Comment thread docs/source/contributing/accessibility-guidelines.md Outdated
@stevepiercy

Copy link
Copy Markdown
Member Author

@Wagner3UB @JeffersonBledsoe @ichim-david would y'all please submit a PR review? Thank you!

@ichim-david

Copy link
Copy Markdown
Member

@stevepiercy looks good, it will have to wait for the merge of the tests done at Salamina sprint in order to create the core/a11y folder. This way your statement on where to place tests is valid.

@stevepiercy stevepiercy added 99 tag: docs-reorg Reorganization of docs following Diátaxis Framework 99 tag: has docs and removed 99 tag: docs-reorg Reorganization of docs following Diátaxis Framework labels Nov 5, 2024
@stevepiercy

Copy link
Copy Markdown
Member Author

@ichim-david @sneridagh @Wagner3UB @JeffersonBledsoe is the blocker complete, so we can merge this?

@github-actions

Copy link
Copy Markdown

Hi There! 👋

We haven't seen any activity on this pull request in a while 😴, and we want to make sure that it's still relevant. Please let us know by:

  • adding a comment about what needs to be done next 💬
  • updating its status and other labels 🏷️

Otherwise close this pull request. 🧹

@github-actions github-actions Bot added 27 status: stale An item that has not received updates in a long time and removed 27 status: stale An item that has not received updates in a long time labels Sep 15, 2025

@thet thet left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM. Also the test location for a11y tests is in the meantime on the right place.

@github-project-automation github-project-automation Bot moved this from Review in progress to Reviewer approved in Accessibility Mar 12, 2026
@github-project-automation github-project-automation Bot moved this from In Progress to Approved in Plone Documentation Mar 12, 2026
@thet

thet commented Mar 12, 2026

Copy link
Copy Markdown
Member

@stevepiercy I rebased this PR on the current main branch. IMO it's good to merge.

@github-project-automation github-project-automation Bot moved this to Needs discussion in Volto Team Meeting Mar 13, 2026
@stevepiercy stevepiercy moved this from Needs discussion to Plan approved in Volto Team Meeting Mar 13, 2026
@stevepiercy stevepiercy moved this from Plan approved to Stale in Volto Team Meeting Mar 13, 2026
@stevepiercy

Copy link
Copy Markdown
Member Author

re-ping @ichim-david @sneridagh @Wagner3UB @JeffersonBledsoe @pnicolli for final review.

@Wagner3UB Wagner3UB left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

@stevepiercy These are my suggestions, just some simple ones to start with. We could talk all day about a11y best practices, but I think these are a great first step. Feel free to adapt or condense the content as you see fit.

Thank you for the collaboration, this is a huge step forward!

Comment thread docs/source/contributing/accessibility-guidelines.md
Comment thread docs/source/contributing/accessibility-guidelines.md
@stevepiercy

Copy link
Copy Markdown
Member Author

@Wagner3UB sorry for the long delay. I've added your suggestions, but reformatted the items into definition lists, as those made more sense semantically than a subsection heading. Please let me know. Thank you!

@read-the-docs-community

Copy link
Copy Markdown

Documentation build overview

📚 volto | 🛠️ Build #33855128 | 📁 Comparing 3a24167 against latest (983f78e)

  🔍 Preview build  

1 file changed
± contributing/accessibility-guidelines.html

@Wagner3UB

Copy link
Copy Markdown
Contributor

@stevepiercy Don’t worry about the time, you did a fantastic job. Thank you!

There’s just one small piece that may have slipped through unnoticed. Other than that, everything looks good to me.

I’ll keep this file on my end and add it to the accessibility meeting notes. I think we can make it even better going forward.

@stevepiercy

Copy link
Copy Markdown
Member Author

@Wagner3UB do you mean this? 😉

https://github.com/plone/volto/pull/6361/changes#diff-ca452a13f79ce27298dba68a1d306365f5b472b89b2662f602e3a5ca4deb48ddR61-R75

@Wagner3UB

Copy link
Copy Markdown
Contributor

@stevepiercy LGTM, and thank you again

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Reviewer approved
Status: Approved
Status: Stale

Development

Successfully merging this pull request may close these issues.

6 participants