-
-
Notifications
You must be signed in to change notification settings - Fork 4.7k
docs: Update CLI docs to prefer local install #15513
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
Conversation
All examples in code blocks are correctly fixed to
|
Thanks, I’ll update the inline examples too for consistency. |
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.
LGTM! 👍
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.
LGTM
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.
LGTM, thanks!
Prerequisites checklist
What is the purpose of this pull request? (put an "X" next to an item)
[x] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofix to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Updated the CLI docs to use local install install of global. We don't recommend global install and so this was confusing for new users.
Also updated some of the code fences to "bash" from "sh" for better compatibility with the new syntax highlighter in the new website.
Fixes #15498
Is there anything you'd like reviewers to focus on?
Did I catch all of the examples?