Use the service_link at the start of the path to the favicon images i… #399
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
tested with local docs, works well now |
kr8n3r
added a commit
that referenced
this pull request
May 2, 2025
## 4.4.0 ### New features - [Use the service link as the start of the path to the favicon images if required](#399) To use the service_link at the start of the path to the favicon images, you need to - set `use_service_link_for_favicon: true`
Merged
maverickvi
pushed a commit
to hmrc/tech-docs-gem
that referenced
this pull request
May 15, 2025
## 4.4.0 ### New features - [Use the service link as the start of the path to the favicon images if required](alphagov#399) To use the service_link at the start of the path to the favicon images, you need to - set `use_service_link_for_favicon: true`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What’s changed
The location of the favicons in the page
<head>has been changed to include theservice_linkfrom the tech-docs.yml configuration file, only ifuse_service_link_for_faviconis set to true (default: false).Identifying a user need
The favicon links added to the core template in v4.0.0 does not work for sites that have a service link. As an example, see the Self Assessment End-to-End Service Guide which has its source in GitHub. There is no favicon on the browser tab because the links look like
<link rel="icon" sizes="48x48" href="/assets/govuk/assets/images/favicon.ico">which resolves to https://developer.service.hmrc.gov.uk/assets/govuk/assets/images/favicon.ico which does not exist. The icon is located at https://developer.service.hmrc.gov.uk/guides/self-assessment-end-to-end-service-guide/assets/govuk/assets/images/favicon.ico. The service_link configuration matches what is missing from the link.
This was raised as an issue by a service guide author. There are 2 dozen or more service guides and roadmaps that either already are or will be affected when updated.
This cannot be applied to all services, so needs an additional switch,
use_service_link_for_faviconto be set to true.