Skip to content
Doug Worsham edited this page Sep 30, 2020 · 8 revisions

Welcome to the research-tips wiki!

Yay!

How to fix a headings accessibility issue

How to fix a headings accessibility issue

  • Go to our issues page
  • select the label "Good first issue" by selecting this option from the label drop down
  • Choose an issue that has something to do with headings
  • Go the the page on the WI+RE website with the issue
  • Run a WAVE test to confirm that the issue is still there - this will also help you find where the issue is on the page.
  • Go to the code for the page
  • Click "Edit"
  • Change the headings so that the first heading on the page is an <h2> and all subsequent headings are in order. They can get more specific, or stay at h2 - just be sure no heading levels get skipped (i.e., don't skip from h2 to h4)
  • Save your changes!
  • Let the site rebuild - it usually takes a minute or so for github to rebuild the site
  • go to the page and re-WAVE it to make sure the issue is gone
  • edit the page again to add the accessibility metadata! Here's an example:

# ACCESSIBILITY INFO

accessibility-info:

- { text: 'WAVE tested - 0 errors', date: '2020-05-22', url: 'https://wave.webaim.org/' }

See https://github.com/UCLALibrary/research-tips/blob/gh-pages/tutorial-workshop-metadata-template.md for more info on the metadata part!

  • All set? close the issue!