-
Notifications
You must be signed in to change notification settings - Fork 21
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
fix: Update instructions for raising support issues #307
Conversation
I had no other way of getting the formatting to render correctly than to abuse the formatting of the documentation. I have spent hours trying to get this right, but my conclusion is that the markdownlinter simply does not account for the mkdocs rendering engine. When formatting these unordered lists in a traditional markdown format they render as flat rather than nested unordered lists.
|
Well it's rather simple: if the linter is wrong, we'll just override the linter. :) I've pushed a fixup commit to that effect that you can subsequently squash into yours. I have a few minor notes on the substance of the PR too, I'll get to that in a bit. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks! This looks pretty good; sorry for the slow review. I have a few suggestions. Please see the inline comments.
7935df2
to
bc66ad1
Compare
Oops. I accidentally force pushed without comitting... |
The ul-indent check in the Markdown linter is overzealous, so disable it.
Bring the documentation up to date with the new Service Center portal design: - Remove old image assets - Add new image asset - Update documentation - General semantic changes
bc66ad1
to
de8fff3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the last minor outstanding changes, rebased on current main
, and brought back the fix to the linter configuration that was accidentally dropped in the force-push. This looks good to me now; I'll go ahead and merge/publish. Thank you!
This PR will bring the documentation up to date with the new Service Center portal design, and also includes some general semantic improvements.