-
Notifications
You must be signed in to change notification settings - Fork 142
Improve SettingUp documentation #1795
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
Conversation
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
ryoarmanda
left a comment
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.
Thanks @ong6 ! As you are trying to spruce up the content for this section, and we haven't discussed this yet in an issue, but I have a slight idea for wording improvement that I have mentioned below (all devs/maintainers, please suggest if this is a related change. If unrelated I can rescind it).
In any case, I have some things that I commented on below:
ryoarmanda
left a comment
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.
Thanks for the follow up! Here are some reviews that we can work on:
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.
Thanks for the further work! My reviews are down below.
I see a quite an amount of changes which are just stylistic to the raw but do not affect the display (like making one line into two, changing unordered list notation from * to -, etc.). Sometimes some of these changes make the raw less clean, e.g. like cramming text that follows after <br> into the same line as the preceding text. We can let the stylistic choice be as is to the original for sections that do not get added/modified, and focus on the content that can be added/modified to the documentations.
ryoarmanda
left a comment
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.
Just a couple nits left, and we're good to go after this :)
ryoarmanda
left a comment
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.
One last minor nit and we're good to merge!
ryoarmanda
left a comment
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.
LGTM! 🎉
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
Co-authored-by: Liu YongLiang <[email protected]>
tlylt
left a comment
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.
LGTM
What is the purpose of this pull request?
Addresses #1721
Overview of changes:
Improved documentation in setting up guide for new users.
Added a list of common setup questions and cleaned up the setting up steps.
Anything you'd like to highlight / discuss:
Let me know if there is anything else you want to add to this section.
Proposed commit message: (wrap lines at 72 characters)
Improve SettingUp documentation
Checklist: ☑️
…tup-doc-update