docs(v2): be more polite #2566
Merged
docs(v2): be more polite #2566
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
lex111
added
the
pr: documentation
|
Deploy preview for docusaurus-2 ready! Built with commit 1f21226 |
yangshun
approved these changes
Apr 9, 2020
website/docs/deployment.md
Outdated
| @@ -9,7 +9,7 @@ To build the static files of your website for production, run: | |||
| npm run build | |||
| ``` | |||
|
|
|||
| Once it finishes, you should see the production build under the `build/` directory. | |||
| Once it finishes, you might want to see the production build under the `build/` directory. | |||
There was a problem hiding this comment.
This is not about telling the user what to do. This is more of telling the user what to expect. I think we can change it to "you will" instead.
|
If we want to improve our docs overall we can use alex. I tried it before but it was kinda noisy and too many to fix so I didn't follow through. |
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.
Motivation
It seems to me that docs should not use constructs that contain "you should", this is somehow not entirely polite for our users.
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Only for
master-docs.Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)