-
Notifications
You must be signed in to change notification settings - Fork 8
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
docs: update the readmes and the how-tos, add quickstart and a tutorial #61
Conversation
Thanks for the pull request, @MaferMazu! Please note that it may take us up to several weeks or months to complete a review and merge your PR. Feel free to add as much of the following information to the ticket as you can:
All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here. Please let us know once your PR is ready for our review and all tests are green. |
9f2ad55
to
410822c
Compare
410822c
to
d066cbd
Compare
Hello @wlvasquez, I was wondering if you could help me review this documentation PR. Can you? I really appreciate any help you can provide. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few notes:
- Replace conjunctions, spell out (you'll for you will)
- Some actionable steps are in "" better that they be Bold text. Eg. Select Add New.
- perhaps you may want to create a short bulleted list to accelerate navigation at the beginning of the article. This way people get a quick view of what topics are covered within the article.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Left several comments to help you polish the articles
Thanks for your detailed feedback, @wlvasquez 🙌 I will apply your suggestions. |
I already applied your suggestion @wlvasquez. If you want to review only my recent changes, you can visit this: e6642cb |
Readme.md and readme.rat: lines 40-44 appear to be steps, but are not numbered. I think you covered everythjng else. Glad I could help 😉 |
Done @wlvasquez :D @felipemontoya, can you help me review this? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work @MaferMazu. I think this has reached a good state to be merged now.
@MaferMazu 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future. |
Description
This PR:
How to test
Run an environment
(By default uses port 8000)
or
(If you need to serve this in another port)
Screenshots