Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): hide table of contents in navigation sidebar for user story #17370

Merged
merged 3 commits into from Aug 24, 2022

Conversation

Shegox
Copy link
Contributor

@Shegox Shegox commented Aug 24, 2022

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.

Maybe we should have an index page for user stories so that each individual story is not in the sidebar at all and so that it doesn't expand when clicking on it - rarkins

Based on this slack thread: https://renovatebot.slack.com/archives/CAFH752JU/p1661266207521999

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository
    Build and tested locally:

Copy link
Member

@viceice viceice left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was on the ways to suggest a markdownlint option1 to solve the error 😅

Footnotes

  1. https://github.com/DavidAnson/markdownlint#configuration

@viceice viceice enabled auto-merge (squash) August 24, 2022 06:16
@viceice viceice merged commit e79402d into renovatebot:main Aug 24, 2022
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 32.174.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 24, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants