Skip to content

Commit

Permalink
docs: CLI documentation standardization (#16563)
Browse files Browse the repository at this point in the history
* docs: CLI intro + copy tweaks

* docs: CLI docs standardization

Fixes #16475

* continue on standardization

* finish first pass of formatting

* finish adding examples

* fixes

* copy edits

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>

* put aliases in the headers

* fix --ext description

* update --rulesdir docs per feedback

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>

* update help text

* readd cli help output

* clarify --ext description

* clarify using --rule w --no-eslintrc

* implement MD and NZ feedback

* Apply suggestions from code review

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* clarify formatter example comments

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

* standardize all headings to Title Case

* Apply suggestions from code review

Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>

Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
Co-authored-by: Amaresh  S M  <amareshsm13@gmail.com>
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
  • Loading branch information
4 people committed Dec 9, 2022
1 parent 90c9219 commit ad44344
Show file tree
Hide file tree
Showing 3 changed files with 333 additions and 160 deletions.
2 changes: 1 addition & 1 deletion docs/src/_data/links.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"team": "/team",

"configuring": "https://eslint.org/docs/user-guide/configuring/",
"fixProblems": "https://eslint.org/docs/user-guide/command-line-interface#fixing-problems",
"fixProblems": "https://eslint.org/docs/user-guide/command-line-interface#fix-problems",

"donate": "/donate",
"openCollective": "https://opencollective.com/eslint",
Expand Down

0 comments on commit ad44344

Please sign in to comment.