docs(fix): updated documentation to fix inconsistencies #175
Conversation
There was a problem hiding this comment.
This looks really good. It is nice to see our docs get fleshed out so nicely. I added a couple inline comments but also while reading through the README.md I found a couple misspellings we have all missed and then have a couple of suggestions for other improvements. I am okay not adding in more details about the database setup without docker since I am hoping most folks will lean on docker now.
Line 27 - misspelling of availability
Line 28 - misspelling of mentors, availability
After Line 32 - Add subheader ‘## Local setup without containers` or something similar
Around Line 63 - Instructions on setting up the postgres database locally would be helpful.
Line 78 - convert header to ### size
Line 266 - 💡Note before information
Thank you for all you have put into making our documentation shine.
|
Thanks for the feedback, @esparr. Comments have been addressed! |
Pull Request Template
1. Targeted Issue
(The first step to a good solution is knowing the problem. Please link the issue here.)
Issue #... or
Ticket #...
https://trello.com/c/aBYGPWSM/152-update-readmemd-to-fix-inconsistencies
2. Overview of Solution
(You've put in the hard work, now's your chance to tell us about it. What's your solution in a nutshell?)
Added Docker install instructions.
Updated Environment Variables to match example.env.
Added $ to beginning of bash commands.
3. Tools Used
(Share the tools, libraries, or techniques you've used in your solution.)
4. Testing Strategy
(No code is complete without tests. Outline what you've tested and how.)
5. Future Implications
(Let's anticipate potential effects of your changes. Are there any potential issues down the line?)
6. Screenshots
(A picture is worth a thousand words. Include screenshots of your changes if relevant.)
7. Code Reviewers
(Who else is in the loop? Mention your team or other contributors here.)
Before you go...
Big high-fives for your incredible pull request! We're thrilled to have you as a contributor! Our team will dig into your proposed changes and give you some feedback or merge them if they're good to go. Your contributions mean the world to us!