Fix documentation when default language is unavailable #684
Conversation
This file contains 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
When a user views the documentation and clicks on a multi-lang snippet to view a specific language, we store that language in local-storage So when they go to view another documentation doc, we remember what the language was, and select that one. So someone who had selected Kotlin, sees Kotlin snippets when they go back later. This had a bug in it. Sometimes when we add a multi-lang snippet we may only have a selection of languages covered in the tested source code. The issue is that when someone who has selected Kotlin previously lands on a page with a missing Kotlin snippet, they see no snippet as all are hidden. This PR introduces a new method which checks if a snippet group is all hidden, and if it is, it forces the first one to be visible
melix
approved these changes
May 13, 2024
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.
When a user views the documentation and clicks on a multi-lang snippet to view a specific language, we store that language in local-storage
So when they go to view another documentation doc, we remember what the language was, and select that one.
So someone who had selected Kotlin, sees Kotlin snippets when they go back later.
This had a bug in it. Sometimes when we add a multi-lang snippet we may only have a selection of languages covered in the tested source code. The issue is that when someone who has selected Kotlin previously lands on a page with a missing Kotlin snippet, they see no snippet as all are hidden.
See micronaut-projects/micronaut-data#2896 for example
This PR introduces a new method which checks if a snippet group is all hidden, and if it is, it forces the first one to be visible