dfe-analytical-services / analysts-guide

A static website to hold guidance, helpful links and code examples for analysts working in DfE.
https://dfe-analytical-services.github.io/analysts-guide/
MIT License
5 stars 3 forks source link

Resolving issue with H1 headers which should not be used. #118

Open Lsnaathorst1 opened 1 week ago

Lsnaathorst1 commented 1 week ago

Bumping all headers where H1 has been used down a layer. Removing --- lines for H2 headers as these are automatically added. Adding --- lines for H2 > H3 headers as they then no longer automatically have them.

(May want to change which headers automatically get a line/don't get a line in future!)

Overview of changes

Changes to remove use of H1 headers in the Analyst's Guide

Why are these changes being made?

Any instances where H1 headers (using just one #) are being used should be changed to H2 headers instead for accessibility purposes. Each page on the site will need to be checked.

Detailed description of changes

Changing use of H1 headers to H2 headers. Bumping all headers in file where H1 has been used down a layer. Lines are automatically put in for H2 headers, so I have removed the manual --- lines where headers have become H2, and added them where H2 headers have become H3 headers (as they don't currently automatically get them)

Issue ticket number/s and link

Check that pages aren't using H1 headers at the top level #85

Checklist before requesting a review

Lsnaathorst1 commented 1 week ago

Analysts Guide: Resolving issue with H1 headers which should not be used