docs: clarify installation step and remove $ prompt confusion - #51
Merged
Conversation
Member
|
That reads more clearly, yep. Thank you. |
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.
Summary
Small documentation improvement to
docs/README.md, based on going through the getting-started flow as a first-time user of the v2 pre-release.Changes
Clarified the installation step
Changed:
To:
## Installation To install MkDocs, run the following command from the command line: pip install mkdocs --pre This will install the version 2.0 pre-release.Why: The original
$ pip install...format could be misread as part of the literal command to type (the$is a conventional shell-prompt symbol, not something to enter) — confirmed this is a real point of confusion by testing it myself. Removing it and adding a clear instructional sentence avoids that confusion for newcomers. Gave the step its own heading for scannability, matching the style used on mkdocs.org.