Improve documentation

I’ve been thinking about this for a while. I just want to show my plan here and maybe get some advice/suggestions before making any change.

• Add feature descriptions (e.g. scopes and how to add more)
• List supported formats (by default)
• Explain “hidden” behaviors (e.g. using prettier from project dependencies)
• Review contributing guidelines
• Add table of contents and links to navigate back to top
• Add links to other documents (contributing guidelines, code of conduct)
• List ESLint rules that match Prettier options (for config tweaks)

[robwise]

Oh also, it might be useful to list a mapping of the eslint rules to their prettier rules, so people know what rules to set in their eslint config

[robwise]

I think we definitely should go into greater detail of how the different options interact with each other. We’ve had a lot of issues in the past where people didn’t properly understand how various settings were getting chosen, especially regarding the eslint integration and which version of prettier gets used. At first, we didn’t have this because it was simpler, but lots of people requested it, so we put it in, and now people are confused by it. I think it’s nice to have, but you’re right, it needs to be made more clear what is going on.

We just need to make sure that people who want a really quick rundown of how to use the plugin aren’t overwhelmed by the amount of information, so if we could somehow put the really quick rundown of what the plugin does and how to use it first, and then link to a different section for those wanting a deep dive, that would be great.

Also, “Add anchors for navigation” should automatically be done by GitHub’s markdown parser if I’m not mistaken.

Contributing guidelines and code of conduct and all of that probably needs updating as .you say, I think a lot of that I just copied over from prettier-eslint and didn’t really update it.

As far as feature descriptions, I almost feel that we should stick to modifying the config-schema.json descrptions so that it’s DRY and so that people don’t have to leave Atom to figure out how things work?