added short description + links to MkDocs docu#6267
Merged
squidfunk merged 2 commits intosquidfunk:masterfrom Nov 2, 2023
Merged
added short description + links to MkDocs docu#6267squidfunk merged 2 commits intosquidfunk:masterfrom
squidfunk merged 2 commits intosquidfunk:masterfrom
Conversation
squidfunk
requested changes
Nov 1, 2023
Owner
squidfunk
left a comment
There was a problem hiding this comment.
Good addition! Minor changes.
Owner
There was a problem hiding this comment.
"See this section" is not a good link name from an A11y point of view. We try to minimize those, because when you step with tab through the docs, your screenreander will not provide enough context. We definitely have some parts where we also do it like that, but when updating our documentation we should always try to give links discernible names, so that they can be understood on their own.
Collaborator
Author
There was a problem hiding this comment.
Hope the wording is better now. Also tried to avoid the repetition of "MkDocs documentation".
squidfunk
approved these changes
Nov 1, 2023
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
I thought the description of how to deploy from your local machine to GH Pages was a bit brief.