alphagov / alphagov/tech-docs-gem

Review the visual hierarchy of headings

Open
#140 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Closure Candidate enhancement
Dominant language
Ruby
Stars
16
Forks
47
Avg merge
1d 21h
Merged PRs (30d)
14

Description

The interpretation of GOV.UK Elements typography styles may have been too literal.
It states:

<h1 class="heading-xlarge">A 48px Bold heading</h1>

<h2 class="heading-large">A 36px Bold heading</h2>

<h3 class="heading-medium">A 24px Bold heading</h3>

<h4 class="heading-small">A 19px Bold heading</h4>

but in reality when looking at Gov.uk content the 36px size is rarely used, with the majority of h2's using the heading-medium size of 24px.

Contributor guide

No contributing guide indexed for this repository

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 by locating the GOV.UK Elements heading styles and the template content that describes them. Compare the documented hierarchy with heading usage in GOV.UK content, then update the interpretation so the documented sizes reflect the observed hierarchy; done means the heading guidance is consistent with that usage.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
design
Issue type
Feature
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.