-
Notifications
You must be signed in to change notification settings - Fork 263
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 documentation links #2268
fix documentation links #2268
Conversation
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.
Assuming you've validated that the updated links are valid (why doesn't mkdocs/markdownlint do this for us??) these all look like good fixes to me. :-)
@@ -291,22 +291,22 @@ This will run the following management commands with default settings, in order: | |||
!!! note | |||
Commands listed here that are not covered in this document here are Django built-in commands. | |||
|
|||
`--no-clearsessions` |
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.
These spaces were purposefully here. Without the double-spaces, the text below will appear on the same line.
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.
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.
Good catch. See also microsoft/vscode#1679 - personally I am not a fan of trailing whitespace for formatting as it's non-obvious, as we see here. Can we use literal <br>
instead?
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.
I don't like the idea of putting literal <br/>
seeing as long as we maintain proper whitespace it should be fine.
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.
I too don't like the literal <br/>
and it will break one of the Markdownlint checks: https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
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.
Can we use 2 line breaks instead of trailing whitespace or <br>
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.
Looks like mkdocs
by design only validates file relative links (../../models/extras/status.md
) and not directory relative links (../../../models/extras/status/
), so let's have these use the validated style.
#2274 overlaps with this but I didn't fix the |
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Co-authored-by: Glenn Matthews <glenn.matthews@networktocode.com>
Closes: #DNE
What's Changed
TODO