Releases: alphagov/tech-docs-gem
Relase v4.1.1
Relase v4.1.0
Release v4.0.0 (major)
4.0.0
Breaking
- BREAKING: drop support for end-of-life Ruby versions 2.7 and 3.0. The minimum Ruby version is now 3.1.
- BREAKING: drop support for IE8
- BREAKING: Upgrade to govuk-frontend v5.7.1 and introduce new Javascript entry point
To upgrade you need to:
- create a
govuk_frontend.js
file your project’ssource/assets/javascripts
directory - add
//= require govuk_frontend_all
into it
Fixes
- Update gem dependencies.
- Declare some missing indirect dependencies to prepare for Ruby 3.4. This also resolves some warnings about this at build time.
- Remove aria-hidden from search label to let assistive technologies see its accessible name
- Use hidden attribute to show/hide expiry notices instead of just CSS
- Only use dialog role for table of contents when it behaves like one (accessibility fix)
- Prevent interactive elements being obscured by sticky table of contents header
- Only wrap images with alt text in hyperlinks
Release 3.5.0
This release includes the new Tudor Crown and govuk-frontend v4.7.0
Release v3.3.1
Fix
This change solves a potential security issue with HTML snippets. Pages indexed in search results have their entire contents indexed, including any HTML code snippets. These HTML snippets would appear in the search results unsanitised, making it possible to render arbitrary HTML or run arbitrary scripts.
You can see more detail about this issue at #323: Fix XSS vulnerability on search results page
Release v3.3.0
New features
There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.4.1.
- Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
- Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend release notes for more information, or contact the GOV.UK Design System team.
Fixes
Release v3.2.1
Fixes
Release v3.2.0
New features
You can now configure your Tech Docs Template (TDT) to build your documentation site to use relative links to pages and assets.
Thanks @eddgrant for contributing this feature and the associated fixes.
This change was introduced in pull request #291: Support sites deployed on paths other than "/" (by generating relative links).
v3.1.0
New features
There are some steps you should follow as the Technical Documentation Template (TDT) now uses GOV.UK Frontend 4.0.0.
- Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
- Check your documentation site displays correctly. If your site does not display correctly, you can refer to the GOV.UK Frontend 4.0.0 release note for more information.
v3.0.1
Fixes
We’ve made the following fixes to the tech docs gem in pull request #281: Don't break TOC when OpenAPI description includes headers:
- we now render OpenAPI Markdown with the same Markdown renderer as other documents
- table of contents (TOC) uses
TechDocsHTMLRenderer
to render the headings with IDs
Thanks to @jamietanna for contributing to this issue and its solution.