feat: add dismissible survey banner to docs site - #289
Merged
Merged
Conversation
Adds a site-wide, dismissible banner linking to the docs feedback survey. It renders between the domain link bar and the main header, above all page content, via the existing Material `announce` block so it appears on every page across all build configs that share the custom theme. Dismissal is remembered per-browser via localStorage, keyed by a banner id so a future survey can be shown again just by bumping that id in theme/main.html.
|
CI Preview: https://docs.dhis2.org/temp/PR/289/en/home.html |
Addresses SonarCloud finding on PR #289.
|
|
CI Preview: https://docs.dhis2.org/temp/PR/289/en/home.html |
Philip-Larsen-Donnelly
approved these changes
Sep 18, 2026
Philip-Larsen-Donnelly
left a comment
Philip-Larsen-Donnelly
left a comment
Contributor
There was a problem hiding this comment.
Looks OK to me.
Ideally we could have made this configurable (both content and visibility) via parameters in the main mkdocs.yml. That would be nice for potential future use.
It's fine to hardcode for now, but perhaps when we disable it, instead of removing completely we could parameterise it?
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Adds a site-wide, dismissible banner linking to the docs feedback survey. It renders between the domain link bar and the main header, above all page content, via the existing Material
announceblock so it appears on every page across all build configs that share the custom theme.Dismissal is remembered per-browser via localStorage, keyed by a banner id so a future survey can be shown again just by bumping that id in theme/main.html.
Proposed to stay active until 8/10/26 and then will remove and revert back