docs: Update page titles, section landing pages, and side TOC #16760
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
eslint-github-bot
bot
added
triage
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
amareshsm
added
accepted
|
The pull requests about IA page moves: eslint/eslint.org#388 and #16665 have been merged |
nzakas
reviewed
Jan 20, 2023
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
bpmutter
requested review from
nzakas and
mdjermanovic
and removed request for
nzakas and
mdjermanovic
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
nzakas
approved these changes
Jan 25, 2023
| @@ -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.
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.
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.
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.
addressed in aaad163
harish-sethuraman
approved these changes
Jan 26, 2023
kecrily
reviewed
Jan 26, 2023
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
|
@mdjermanovic accepted your suggestions and implemented changes based on your feedback in aaad163 |
crapStone
pushed a commit
to Calciumdibromid/CaBr2
that referenced
this pull request
Feb 2, 2023
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>
1 task
eslint-github-bot
bot
added
the
archived due to age
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
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