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

Improve documentation #10

Draft
wants to merge 34 commits into
base: main
Choose a base branch
from
Draft

Improve documentation #10

wants to merge 34 commits into from

Conversation

nickserv
Copy link
Owner

@nickserv nickserv commented Jul 22, 2020

  • Investigate using eslint-find-rules instead of custom scripts
  • Add examples and explanations to current documentation (like Airbnb)
  • Add ESLint rule references and enforce that they're used
  • Reorganize categories (possibly based on ESLint's own rule categories)
  • Document remaining rules
  • Consider consolidating scripts
  • Consider getting rid of meta.docs.category (removed in ESLint 8)
    • meta.type is an alternative

@nickserv nickserv marked this pull request as draft July 22, 2020 14:34
@nickserv nickserv added this to the 1.0.0 milestone Aug 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant