Skip to content

Conversation

@ong6
Copy link
Contributor

@ong6 ong6 commented Feb 24, 2022

What is the purpose of this pull request?

  • Documentation update
  • Bug fix
  • Feature addition or enhancement
  • Code maintenance
  • Others, please explain:

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: ☑️

  • Updated the documentation for feature additions and enhancements
  • Added tests for bug fixes or features
  • Linked all related issues
  • No unrelated changes

…tup-doc-update

ong6 added 14 commits August 29, 2021 16:46
@ong6 ong6 changed the base branch from master to all-contributors/add-kaixin-hc February 24, 2022 08:38
@ong6 ong6 changed the base branch from all-contributors/add-kaixin-hc to master February 24, 2022 08:38
@ong6 ong6 changed the title Pulled from Master Improve SettingUp documentation Feb 24, 2022
Copy link
Contributor

@ryoarmanda ryoarmanda left a 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:

Copy link
Contributor

@ryoarmanda ryoarmanda left a 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:

Copy link
Contributor

@ryoarmanda ryoarmanda left a 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.

Copy link
Contributor

@ryoarmanda ryoarmanda left a 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 :)

Copy link
Contributor

@ryoarmanda ryoarmanda left a 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!

Copy link
Contributor

@ryoarmanda ryoarmanda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🎉

@ryoarmanda ryoarmanda added this to the 4.0 milestone Mar 9, 2022
@ryoarmanda ryoarmanda requested a review from tlylt March 10, 2022 07:10
@ong6 ong6 requested a review from tlylt March 10, 2022 13:38
Copy link
Contributor

@tlylt tlylt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants