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

Make documentation easier for new users #746

Open
ajafff opened this issue Jan 17, 2021 · 0 comments
Open

Make documentation easier for new users #746

ajafff opened this issue Jan 17, 2021 · 0 comments

Comments

@ajafff
Copy link
Member

ajafff commented Jan 17, 2021

The current documentation is a bit hard to grasp. The main readme should describe how to start and what is necessary for users.

For users landing on a rule's documentation, there should be an easy path to find out how to get started using that rule.

Remove references to TSLint. It's EOL, so we don't need to compare to it. Maybe create a page describing how to migrate from TSLint and which rules are similar.

(Re)move all the nerdy stuff from the main readme. It adds no value for most readers.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant