chore(docs): hide table of contents in navigation sidebar for user story #17370
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
viceice
approved these changes
Aug 24, 2022
There was a problem hiding this comment.
was on the ways to suggest a markdownlint option1 to solve the error 😅
Footnotes
|
🎉 This PR is included in version 32.174.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Changes
This PR hides the table of content in the navigation sidebar for just a single page (the user story).
The implementation is based on this recommendation from squidfunk/mkdocs-material#2162 (comment).
Context
For users it might be confusing to see the heading like
I don’t feel like upgrading, what if?in the navigation sidebar and thus we only display the name of the user story without rendering the table of content.Based on this slack thread: https://renovatebot.slack.com/archives/CAFH752JU/p1661266207521999
Documentation (please check one with an [x])
How I've tested my work (please tick one)
I have verified these changes via:
Build and tested locally: