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
docs: Update page titles, section landing pages, and side TOC #16760
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
The pull requests about IA page moves: eslint/eslint.org#388 and #16665 have been merged |
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.
This is looking pretty good, just a couple of questions.
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
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!
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 pending @mdjermanovic's changes
@@ -21,34 +21,26 @@ In order to work with ESLint as a developer, it's recommended that: | |||
|
|||
If that sounds like you, then continue reading to get started. |
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.
I think the opening section needs to be rewritten because this page is now only about extending ESLint while the current text in this section is mostly about contributing to ESLint.
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.
addressed in aaad163
docs/src/extend/index.md
Outdated
|
||
## Section 6: [Working with Custom Parsers](custom-parsers) | ||
## [Custom Parsers](custom-parsers) | ||
|
||
If you aren't going to use the default parser of ESLint, this section explains about using custom parsers. |
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.
While here, I think we should update this description because the linked page explains how to create custom parsers, not how to use custom parsers.
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.
addressed in aaad163
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.
Looks Great To me 🎉
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.
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
@mdjermanovic accepted your suggestions and implemented changes based on your feedback in aaad163 |
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!
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.32.0` -> `8.33.0`](https://renovatebot.com/diffs/npm/eslint/8.32.0/8.33.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.33.0`](https://github.com/eslint/eslint/releases/tag/v8.33.0) [Compare Source](eslint/eslint@v8.32.0...v8.33.0) #### Features - [`2cc7954`](eslint/eslint@2cc7954) feat: add `restrictDefaultExports` option to no-restricted-exports rule ([#​16785](eslint/eslint#16785)) (Nitin Kumar) #### Documentation - [`17f4be2`](eslint/eslint@17f4be2) docs: Fix examples in no-multiple-empty-lines rule ([#​16835](eslint/eslint#16835)) (jonz94) - [`9c7cfe3`](eslint/eslint@9c7cfe3) docs: 'Source Code' content in 'Set up Development Environment' page ([#​16780](eslint/eslint#16780)) (Ben Perlmutter) - [`ede5c64`](eslint/eslint@ede5c64) docs: Custom processors page ([#​16802](eslint/eslint#16802)) (Ben Perlmutter) - [`2620614`](eslint/eslint@2620614) docs: Code of Conduct page ([#​16781](eslint/eslint#16781)) (Ben Perlmutter) - [`50a8efd`](eslint/eslint@50a8efd) docs: report a sec vulnerability page ([#​16808](eslint/eslint#16808)) (Ben Perlmutter) - [`ed60afd`](eslint/eslint@ed60afd) docs: Update page titles, section landing pages, and side TOC ([#​16760](eslint/eslint#16760)) (Ben Perlmutter) - [`333c712`](eslint/eslint@333c712) docs: add background to code-path-diagrams for dark-mode ([#​16822](eslint/eslint#16822)) (Tanuj Kanti) - [`f5f7b9b`](eslint/eslint@f5f7b9b) docs: Update README (GitHub Actions Bot) - [`2aa4f5f`](eslint/eslint@2aa4f5f) docs: no-constant-condition: Add multi-comparison example ([#​16776](eslint/eslint#16776)) (Sebastian Simon) - [`40287db`](eslint/eslint@40287db) docs: Remove Google Group icon ([#​16779](eslint/eslint#16779)) (Nicholas C. Zakas) - [`ea10ca5`](eslint/eslint@ea10ca5) docs: 'a .eslint' -> 'an .eslint' for consistency ([#​16809](eslint/eslint#16809)) (Ben Perlmutter) - [`3be0748`](eslint/eslint@3be0748) docs: add example for nodejs lintText api ([#​16789](eslint/eslint#16789)) (Siva K) - [`ce4f5ff`](eslint/eslint@ce4f5ff) docs: Replace removed related rules with a valid rule ([#​16800](eslint/eslint#16800)) (Ville Saalo) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNC4xMTUuMSIsInVwZGF0ZWRJblZlciI6IjM0LjExOS4yIn0=--> Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1759 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>
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)
As part of the docs IA update, changed the table of contents, page names, and section landing pages to reflect the updated information architecture.
Misc other notes:
Is there anything you'd like reviewers to focus on?
These issues should be completed following the work in this PR:
Resolves: #16720