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: Add Resources section to rule pages #15901
Conversation
✅ Deploy Preview for docs-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
{% set resources_content %} | ||
<h2 id="resources">Resources</h2> | ||
<ul> | ||
<li><a href="https://github.com/eslint/eslint/blob/main/lib/rules/{{ title }}.js">Rule source</a></li> |
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.
On the current website, we're using HEAD
instead of main
. Just to check - did you intentionally switch to main
?
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.
Yes. We used HEAD to aid with the transition from master to main. I don’t think it’s necessary anymore.
I agree that an additional link to the documentation source seems unnecessary. |
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.
One URL fix, then LGTM. I agree we don't need a link to the docs.
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 once @btmills' suggested change is applied.
Co-authored-by: Brandon Mills <btmills@users.noreply.github.com>
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.16.0` -> `8.17.0`](https://renovatebot.com/diffs/npm/eslint/8.16.0/8.17.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.17.0`](https://github.com/eslint/eslint/releases/tag/v8.17.0) [Compare Source](eslint/eslint@v8.16.0...v8.17.0) #### Features - [`55319e1`](eslint/eslint@55319e1) feat: fix indent bug with semicolon-first style ([#​15951](eslint/eslint#15951)) (Milos Djermanovic) - [`f6d7920`](eslint/eslint@f6d7920) feat: add `allowNamedExports` option to no-use-before-define ([#​15953](eslint/eslint#15953)) (Milos Djermanovic) #### Bug Fixes - [`54c0953`](eslint/eslint@54c0953) fix: cleanup typos ([#​15939](eslint/eslint#15939)) (Nick Schonning) - [`845a7af`](eslint/eslint@845a7af) fix: typo ocatal -> octal ([#​15940](eslint/eslint#15940)) (Nick Schonning) #### Documentation - [`b915018`](eslint/eslint@b915018) docs: Update website UI to latest ([#​15944](eslint/eslint#15944)) (Nicholas C. Zakas) - [`f0bb609`](eslint/eslint@f0bb609) docs: Update Exponentiation operator MDN link ([#​15960](eslint/eslint#15960)) (Pranjal Jain) - [`baa0153`](eslint/eslint@baa0153) docs: Use correct past tense "left" instead of "leaved" ([#​15950](eslint/eslint#15950)) (Frederik Braun) - [`1351a9b`](eslint/eslint@1351a9b) docs: Add Resources section to rule pages ([#​15901](eslint/eslint#15901)) (Nicholas C. Zakas) - [`68cf0fb`](eslint/eslint@68cf0fb) docs: cleanup typos ([#​15936](eslint/eslint#15936)) (Nick Schonning) - [`13b62ae`](eslint/eslint@13b62ae) docs: use-dart-sass instead of node-sass ([#​15912](eslint/eslint#15912)) (Deepshika S) - [`c81c5d6`](eslint/eslint@c81c5d6) docs: add social media links ([#​15920](eslint/eslint#15920)) (Deepshika S) - [`0d6a50b`](eslint/eslint@0d6a50b) docs: fix openjs link ([#​15917](eslint/eslint#15917)) (Amaresh S M) - [`54910f5`](eslint/eslint@54910f5) docs: display version in mobile view ([#​15909](eslint/eslint#15909)) (Amaresh S M) #### Chores - [`da694b9`](eslint/eslint@da694b9) chore: avoid theme flashes ([#​15927](eslint/eslint#15927)) (Strek) - [`f836743`](eslint/eslint@f836743) chore: Use build hook for docs deploy ([#​15945](eslint/eslint#15945)) (Nicholas C. Zakas) - [`ce035e5`](eslint/eslint@ce035e5) test: cleanup typos ([#​15937](eslint/eslint#15937)) (Nick Schonning) - [`10249ad`](eslint/eslint@10249ad) chore: use addEventListener instead of addListener ([#​15923](eslint/eslint#15923)) (Amaresh S M) - [`5f5c1fb`](eslint/eslint@5f5c1fb) chore: lint eleventy config file ([#​15904](eslint/eslint#15904)) (Milos Djermanovic) - [`8513d37`](eslint/eslint@8513d37) chore: update Rule typedefs ([#​15915](eslint/eslint#15915)) (Milos Djermanovic) - [`55534f1`](eslint/eslint@55534f1) test: ensure no-restricted-imports works with NodeJS imports ([#​15907](eslint/eslint#15907)) (Nick Mazuk) </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, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1395 Reviewed-by: 6543 <6543@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)
Added the "Resources" section to rule pages.
Is there anything you'd like reviewers to focus on?
I only added "Rule source" and "Test source", but not "Documentation source" because we have a big "Edit Page" button right under this section. Is that okay?