Skip to content

Docs: per-rule docs (eslint-doc-generator)? #62

@JoshuaKGoldberg

Description

@JoshuaKGoldberg

👋 I was just pointed to this plugin by @atilafassina - and it's great, thank you for making it! +1 to having some system to enforce good react-refresh usages.

But, I found it hard to learn about this plugin and rule. There's no explicit listing of the rule(s) it comes with and so I had to peek into the src/ directory.

Most ESLint plugins today either have their own website (e.g. https://perfectionist.dev) or use eslint-doc-generator to create docs and keep them up-to-date. The latter is what most projects do that don't have a huge amount of options, rules, etc.

Would you be open to using eslint-doc-generator to align the docs to other plugins? Or failing that, having docs similar to it?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy