Skip to content
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

Closed
selfagency opened this issue Oct 12, 2021 · 5 comments
Closed

Documentation update request #3993

selfagency opened this issue Oct 12, 2021 · 5 comments
Labels
documentation Documentation ("docs") that needs adding/updating

Comments

@selfagency
Copy link

Capto_Capture 2021-10-12_02-20-03_PM 2021-10-12 14_24_52

Love you guys! Thanks for everything you do! But can you please not bury the recommended installation and configuration three clicks deep?

@selfagency selfagency added package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for maintainers to take a look labels Oct 12, 2021
@JoshuaKGoldberg
Copy link
Member

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.

@bradzacher
Copy link
Member

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.

@JoshuaKGoldberg
Copy link
Member

JoshuaKGoldberg commented Oct 25, 2021

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.

@abierbaum
Copy link

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.

@bradzacher
Copy link
Member

closing this as we've released new version of the website with much cleaner layout and navigation.

@bradzacher bradzacher added documentation Documentation ("docs") that needs adding/updating and removed package: eslint-plugin Issues related to @typescript-eslint/eslint-plugin triage Waiting for maintainers to take a look labels Nov 16, 2021
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 17, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Documentation ("docs") that needs adding/updating
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants