alphagov / govuk-content-api-docs

Documentation for the GOV.UK Content API.
https://content-api.publishing.service.gov.uk
MIT License
4 stars 7 forks source link

Bump govuk_tech_docs from 2.3.0 to 3.1.0 #81

Closed dependabot[bot] closed 2 years ago

dependabot[bot] commented 2 years ago

Bumps govuk_tech_docs from 2.3.0 to 3.1.0.

Release notes

Sourced from govuk_tech_docs's releases.

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.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. 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](alphagov/tech-docs-gem#281):

  • 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.

v3.0.0

Breaking changes

The search user experience is now more accessible for screenreader users. Search results are now on a separate page instead of a modal window.

Users can no longer see search results as they type. They must press the Return key or select the search button to see the search results page.

This was added in [pull request #263: Change search to only show results after submit](alphagov/tech-docs-gem#263).

Fixes

v2.4.3

v2.4.2

v2.4.1

v2.4.0

Changelog

Sourced from govuk_tech_docs's changelog.

3.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.

  1. Update your documentation site to use the latest template version. You can follow the TDT guidance on using the latest template version.
  2. 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.

3.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](alphagov/tech-docs-gem#281):

  • 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.

3.0.0

Breaking changes

The search user experience is now more accessible for screenreader users. Search results are now on a separate page instead of a modal window.

Users can no longer see search results as they type. They must press the Return key or select the search button to see the search results page.

This was added in [pull request #263: Change search to only show results after submit](alphagov/tech-docs-gem#263).

Fixes

2.4.3

2.4.2

2.4.1

2.4.0

... (truncated)

Commits
  • 6f84654 Merge pull request #290 from alphagov/PippaClarkGDS-patch-1
  • 88d900d Release v3.1.0
  • 3236186 Update CHANGELOG.md
  • 84a1839 Merge pull request #286 from alphagov/update-govuk-frontend-v4.0.0
  • 02c09ca Update to GOV.UK Frontend v4.0.0
  • 907e990 Add skip link data module to initialise JS
  • 28de5bc Update header HTML
  • 5f8c197 Merge pull request #288 from alphagov/release-v3.0.1
  • 74d1f1c Release v3.0.1
  • 907edfd Merge pull request #287 from alphagov/release-note-3.0.1
  • Additional commits viewable in compare view


Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
dependabot[bot] commented 2 years ago

Superseded by #84.