Update documentation #48
Conversation
- Rewrite section Installation to include a quickstart guide with ordered steps and copy/paste code code examples - Move sections Example projects and Troubleshooting near the end - Move section Support for earlier versions after Troubleshooting
There was a problem hiding this comment.
Thanks Matt for the PR! This does look better. The reasoning behind putting the troubleshooting and example projects first was that I got so many issues where people wouldn't even check the troubleshooting section before they created an issue. Perhaps I should include them in the Issue Template.
Could we put a TOC with some of the 2nd level headers as links (Installation, Configuration, Troubleshooting, Example Projects)
Capitalize heading Co-authored-by: Rebecca Vest <olserebe@hotmail.com>
Update heading Co-authored-by: Rebecca Vest <olserebe@hotmail.com>
Co-authored-by: Rebecca Vest <olserebe@hotmail.com>
Co-authored-by: Rebecca Vest <olserebe@hotmail.com>
Co-authored-by: Rebecca Vest <olserebe@hotmail.com>
|
@idahogurl Apologies for the late response. Those were all good suggestions. Let me know if there's anything I missed. |
|
Closes #46 |
|
🎉 This PR is included in version 5.0.4 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
@idahogurl I completely missed your request before submitting my final request for a review of changes. My apologies for that. I see that you implemented it yourself though. It looks great! Thanks for accepting the PR. I hope it helps reduce some of the complexity with installing and configuring everything. I love this extension. It's the default for all my personal projects. Thanks for making it and thanks for allowing me to contribute to it! |
|
@mattbrannon No worries! You did most of the heavy lifting. Thanks for the PR again. |
This PR attempts to simplify the process of setting up a new project with the
vs-code-prettier-eslintextension. Changes to theREADME.mdinclude the following:Moving the troubleshooting and examples sections to the end and the installation section to the beginning allows the reader to read from top to bottom without as much jumping back and forth between sections.
The goal of the rewrite is help people get things installed and setup as quickly and easily as possible. Code examples are provided that users can copy/paste directly into their terminal. The section detailing setup includes a json snippet that users can paste directly into their workspace settings. A link to the troubleshooting section is also provided in case something goes wrong.
It's quite a big change to the current documentation so please let me know what you think. Any and all feedback is welcome.