stylelint-rscss icon indicating copy to clipboard operation
stylelint-rscss copied to clipboard

Reorganizing docs

Open mik01aj opened this issue 8 years ago • 1 comments

Hi, I thought that it would be a good idea to spend some time on the docs so they're easier to read and more similar to other stylelint/eslint plugins.

My ideas would be to:

  • put a list of rules in the readme, and have the docs organized rule-wise,
  • add example config for people who prefer not to extend
  • extend docs of the big class-format rule.

@rstacruz, if you like this idea, I'd submit a PR in October as a part of Hacktoberfest :)

mik01aj avatar Sep 29 '16 14:09 mik01aj

Go for it!

On Thu, Sep 29, 2016, 10:26 PM Mikołaj D. [email protected] wrote:

Hi, I thought that it would be a good idea to spend some time on the docs so they're easier to read and more similar to other stylelint/eslint plugins.

My ideas would be to:

  • put a list of rules in the readme, and have the docs organized rule-wise,
  • add example config for people who prefer not to extend
  • extend docs of the big class-format rule.

@rstacruz https://github.com/rstacruz, if you like this idea, I'd submit a PR in October as a part of Hacktoberfest https://hacktoberfest.digitalocean.com/ :)

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/rstacruz/stylelint-rscss/issues/8, or mute the thread https://github.com/notifications/unsubscribe-auth/AAEikYaZuQLxL8Cp-o5Oeibg597Zjm6uks5qu8qUgaJpZM4KKDms .

rstacruz avatar Sep 29 '16 17:09 rstacruz