-
-
Notifications
You must be signed in to change notification settings - Fork 2.6k
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
Documentation update request #3993
Comments
Agreed 😄, I have felt this pain myself. @bradzacher, has anybody taken steps to revisit this? I'd be happy to send a draft PR to reorganize if not. |
I didn't hugely want to spend time duplicating out docs when all its doing is saving a click or two. We had plans to use docasaurus to generate a website which would make the in-repo docs a moot point as we'd just link to the website. Armano was working on it but never finished it and nobody else has spent the time. There's an open PR on it. That whole landing page is a mess of words that most people don't care about so we need to clean it all up. But again - nobody has been so motivated yet. |
Reference: #3147 -> https://typescript-eslint-armano.netlify.app/ That new site is excellent and will help a lot with the docs reading! I've reached out to @armano2 to see if it would be inconvenient for me to push that work forward. |
Wow, that new site is exactly what I was looking for. I couldn't find a list of the rules and descriptions of them with the current site. The new site above is much easier to make sense of as a new user. |
closing this as we've released new version of the website with much cleaner layout and navigation. |
Love you guys! Thanks for everything you do! But can you please not bury the recommended installation and configuration three clicks deep?
The text was updated successfully, but these errors were encountered: