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

Reorganizing docs #8

Open
mik01aj opened this issue Sep 29, 2016 · 1 comment
Open

Reorganizing docs #8

mik01aj opened this issue Sep 29, 2016 · 1 comment

Comments

@mik01aj
Copy link
Contributor

mik01aj commented Sep 29, 2016

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 :)

@rstacruz
Copy link
Owner

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
#8, or mute the thread
https://github.com/notifications/unsubscribe-auth/AAEikYaZuQLxL8Cp-o5Oeibg597Zjm6uks5qu8qUgaJpZM4KKDms
.

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

No branches or pull requests

2 participants