alphagov/notifications-tech-docs

Technical Documentation for GOV.UK Notify

notifications-tech-docs's Issues

Dependabot can't resolve your Ruby dependency files

Dependabot can't resolve your Ruby dependency files.

As a result, Dependabot couldn't update your dependencies.

The error Dependabot encountered was:

Bundler::VersionConflict with message: Bundler could not find compatible versions for gem "multipart-post":
  In Gemfile:
    faraday (~> 0.15.4) was resolved to 0.15.4, which depends on
      multipart-post (>= 1.2, < 3)

Could not find gem 'multipart-post (>= 1.2, < 3)', which is required by gem 'faraday (~> 0.15.4)', in any of the sources.

If you think the above is an error on Dependabot's side please don't hesitate to get in touch - we'll do whatever we can to fix it.

You can mention @dependabot in the comments below to contact the Dependabot team.

Heading structure and title are wrong

The docs for each language are a single page but have two <h1>s. Also, the <title> for each set of docs doesn't mention which API client those docs are for.

Both these are likely to fail an accessibility audit due to their effect on users of assistive technologies.

Multiple H1s

This section in the HTML5 spec explains that no assistive technologies support document outlines with multiple h1s:

https://www.w3.org/TR/html52/sections.html#creating-an-outline

This means the structure of these docs is currently broken.

This does help you orient yourself when reading the links in the nav.

The tech-docs-gem only adds a bold link for a <h1>s. If we didn't use <h1>s for the section headings, the nav would look like that in the WCAG Primer:

Generic text in the title element

The <title> element for the docs for each language is the same:

"Client documentation - GOV.UK Notify | Notify"

This matches an example of how to fail success criteria 2.4.2 in the WCAG docs:

https://www.w3.org/TR/2016/NOTE-WCAG20-TECHS-20161007/F25#F25-failex2

Remove additional sentence about contacting support

Introduced here: #22

Can be removed when this issue is resolved: https://github.com/alphagov/tech-docs-template/issues/148