docs(settings): bunch of fixes and improvements #5177
Merged
Conversation
This file contains 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
CoolCat467
suggested changes
Jul 18, 2024
| # On Windows. | ||
| .venv\Scripts\activate | ||
| ``` | ||
|
|
||
| 1. Run the development server with: |
There was a problem hiding this comment.
The bullet point numbers below this are now off
There was a problem hiding this comment.
In markdown, it doesn't matter which number you use for ordered lists, as using "1" for multiple consecutive items will still generate a numerically ordered list: https://www.markdownguide.org/basic-syntax/#ordered-lists
There was a problem hiding this comment.
Interesting, didn't know about that feature!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Spotted some issues in the settings documentation, and room for small improvements by linking to PEPs/RFCs.
Also updating contribution documentation to mention that it's necessary to enable the virtual environment before running
mkdocs serve.Test Plan
Running documentation locally.