docs: add missing newline to ensure that bulleted list is rendered correctly #595
Conversation
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
|
Review changes with |
Collaborator
|
Hi, checking and formatting the docs via https://github.com/hukkin/mdformat on CI sounds interesting. You could use something like this: mdformat --check ./*.md docs/**It is enough to check for all root-level only and Can you please add it to CI as a new step? I created a dedicated workflow for the project docs. Just make sure to add it after the typos check and before the mkdocs build. -- Btw, I believe you can close this PR and address the same in a new one by applying the formatting via |
Contributor
Author
|
Closing in favour of #597. |
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.
Description
I was going through the changelog of the latest version and noticed an incorrectly rendered list in https://static-web-server.net/features/markdown-content-negotiation/#llm-friendly-content-with-llmstxt at the end of that section:
Related Issue
Motivation and Context
Note that it would be possible to catch (and fix) this automatically via
mdformatwith themdformat-mkdocsplugin. I use it as a pre-commit hook but could also be added to CI only.Let me know if this is something you would find useful and I could contribute a PR.
How Has This Been Tested?
Screenshots (if appropriate):