docs: describe update steps for ESLint, Node, and TypeScript #6251
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. |
✅ Deploy Preview for typescript-eslint ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
|
||
| ### ESLint | ||
|
|
||
| > The version range of ESLint currently supported is `^6.0.0 || ^7.0.0 || ^8.0.0`. |
There was a problem hiding this comment.
Not introduced in this PR, but I strongly suggest using admonitions like :::info instead. Quotes should be used for quotes and not other things.
There was a problem hiding this comment.
Heh, an old habit from working in raw Markdown. +1 on the semantics of switching away from quotes. But I do prefer the visual of a quote because admonitions take the extra line to indicate their type.
Has there been any discussion about making single-line admonitions? My GitHub+Google searching is failing me, but I can make a Discussion if not.
There was a problem hiding this comment.
No discussion yet, but IMO it's fine to make the doc page a bit less densely populated :)
There was a problem hiding this comment.
There was a problem hiding this comment.
@Josh-Cena what do you think - should we stick with the larger admonitions, or smaller-but-semantically-off quotes? I'll defer to your suggestion 😄
There was a problem hiding this comment.
I'll go with the same quotes as before for now. But once we can use single-line admonitions per facebook/docusaurus#8458 (comment) I would enthusiastically switch us over!
PR Checklist
Overview
Nests the docs as a Dependant Version Upgrades page under Versioning. Proposes a slightly different process for TypeScript specifically.