Skip to content

1.1.0

Compare
Choose a tag to compare
@ESKYoung ESKYoung released this 12 Jul 16:58
· 111 commits to main since this release
1e15cba

Changes include:

  • revising documentation to include further detail on the cookiecutter package, and how to modify the structure of govcookiecutter
  • fixing incorrect contact email address.
  • adding tests to check for broken links in the Sphinx documentation - ensures future releases of govcookiecutter have the correct links throughout the documentation
  • adding information on cruft, which could help future projects generated from govcookiecutter stay up-to-date with any changes we release here
  • refactoring documentation (Markdown/reStructuredText files only, predominately excluding CODE_OF_CONDUCT.md and CONTRIBUTING.md) so that it is more accessible, including guidance on how to write accessible documentation
  • GitHub Action to deploy documentation to GitHub Pages on release

Accessibility checks include:

  • building documentation against govuk-tech-docs-sphinx-theme
  • checking against WAVE Web Accessibility Evaluation Tool
  • checking link test is descriptive
  • checking hierarchy of page headings
  • removing italics, and bold text, and only using curly braces around block capitals for placeholders in code examples
  • checking for accessible language
    • using alex.js
    • replacing instances of click with select or choose
    • removing latin phrases, i.e. ad hoc, via
    • using GOV.UK inclusive language
    • replacing negative contractions
    • aiming not to have long sentences or paragraphs (25 words per sentence; 5 lines per paragraph)
    • checking for unique titles in documentation
    • checking diagrams and images for alt text as well as surrounding contextual text, removing diagrams/images that do not add anything to a user's understanding, removing screenshots if possible, use accessible SVGs
    • checking for inaccessible formats