chore(website): move rule attributes to top of docs pages #5702
Conversation
|
Thanks for the PR, @JoshuaKGoldberg! typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community. The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately. Thanks again! 🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## main #5702 +/- ##
==========================================
+ Coverage 91.01% 93.82% +2.80%
==========================================
Files 365 134 -231
Lines 11969 1506 -10463
Branches 3487 226 -3261
==========================================
- Hits 10894 1413 -9481
+ Misses 781 60 -721
+ Partials 294 33 -261
Flags with carried forward coverage won't be shown. Click here to find out more. |
PR Checklist
Overview
Shamelessly copies the idea from the new eslint.org designs [eslint.org redesign blog post]. We don't have nearly as fancy or thought out a website design system, but the idea of putting emoji-labeled mini-admonitions for rule attributes is a good one. Cheers + thanks @haydenbleasel! 😄
Also moves the
.eslintrc.cjsto be earlier in the page - now just before the first h2, and therefore after any opening paragraphs of info. This makes the pages feel to me like they start more consistently & lead with the rule attributes, basic information, and how to enable individually.