Fix 2 potencial bugs in docs #1878
Merged
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
Signed-off-by: Travis Beckham <[email protected]>
Signed-off-by: Travis Beckham <[email protected]>
kflynn
approved these changes
Nov 20, 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.
Bug 1
Currently, if a section in the Docs sidenav only contains child sections and not any regular pages, the submenu will not be displayed for that section. The submenu should still be displayed in this case.
With this PR, the sidenav has been fixed to show a submenu of a section, if it only contains child sections.
There are currently not any sections in the Docs sidenav that only contain other sections, but I'm fixing this bug just in case we do in the future.
Bug 2
Currently, the
section-tocshortcode is incorrectly listing pages that have theunlistedparam set.With this PR, unlisted pages will not be shown when using the
section-tocshortcode.There are currently not any index pages that use the
section-tocshortcode and also have unlisted pages.