Improve SettingUp documentation by ong6 · Pull Request #1795 · MarkBind/markbind

ong6 · 2022-02-24T08:36:38Z

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

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

Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

ryoarmanda

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

Thanks for the follow up! Here are some reviews that we can work on:

ryoarmanda

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

Just a couple nits left, and we're good to go after this :)

ryoarmanda

One last minor nit and we're good to merge!

ryoarmanda

LGTM! 🎉

Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

tlylt

LGTM

ong6 added 14 commits August 29, 2021 16:46

Pulled from Master
55572b9

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
49d8fe2

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
32b5475

Merge branch 'MarkBind:master' into master
ddfa24a

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
2537a1f

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
243df4a

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
9dbdeef

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
7d37a43

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
6423544

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
de29400

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
dc0a9db

Merge branch 'master' ofhttps://github.com/MarkBind/markbind
41d61ad

Merge branch 'master' ofhttps://github.com/MarkBind/markbindinto se…
77ec617
…tup-doc-update

added Q and A sections to help new devs
34d8944

ong6 changed the base branch from master to all-contributors/add-kaixin-hcFebruary 24, 2022 08:38

ong6 changed the base branch from all-contributors/add-kaixin-hc to masterFebruary 24, 2022 08:38

ong6 changed the title ~~Pulled from Master~~Improve SettingUp documentationFeb 24, 2022

tlylt requested changes Feb 24, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated

ong6and others added 5 commits February 24, 2022 21:53

Update docs/devGuide/settingUp.md
92ba2df
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
8481813
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
6b24e26
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
10fabf7
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
f84094c
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

ryoarmanda requested changes Feb 26, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated

ong6 added 3 commits February 27, 2022 23:00

updated documents based on comments
c51a8e4

added more documentation
88ec938

fixed linting
5882dcb

ryoarmanda reviewed Mar 3, 2022
View reviewed changes

Comment threaddocs/devGuide/workflow.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated

revert workflow
f345571

ryoarmanda requested changes Mar 4, 2022
View reviewed changes

Comment threaddocs/devGuide/workflow.md
Comment threaddocs/devGuide/settingUp.md Outdated

ong6 added 4 commits March 5, 2022 00:38

fixed issues
932cc0d

Updated based on yl feedback
bc4d211

updated wording
87a5393

fixed punctuation and typo
fa29eb2

ryoarmanda reviewed Mar 6, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated

ryoarmanda reviewed Mar 6, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated

wording fixes
0afdbf9

ryoarmanda reviewed Mar 7, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated

ong6 added 2 commits March 9, 2022 01:54

fixed whitespace
d3e8019

removed all trailling whitespaecs
cc5bcc8

ryoarmanda approved these changes Mar 9, 2022
View reviewed changes

ryoarmanda added this to the 4.0 milestone Mar 9, 2022

ryoarmanda requested a review from tlylt March 10, 2022 07:10

tlylt requested changes Mar 10, 2022
View reviewed changes

Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated
Comment threaddocs/devGuide/settingUp.md Outdated

ong6and others added 5 commits March 10, 2022 21:36

Update docs/devGuide/settingUp.md
2973d2c
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
0f19b77
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
f78f22d
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
9e6f0de
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

Update docs/devGuide/settingUp.md
f2bdc8c
Co-authored-by: Liu YongLiang <41845017+tlylt@users.noreply.github.com>

ong6 requested a review from tlylt March 10, 2022 13:38

tlylt approved these changes Mar 10, 2022
View reviewed changes

ryoarmanda merged commit 28c5097 into MarkBind:masterMar 10, 2022

tlylt mentioned this pull request Mar 10, 2022
Setting up on windows 11 does not work as intended? #1721
Closed

tlylt mentioned this pull request Aug 9, 2022
Improve setting up section of the developer guide #1996
Open

Uh oh!

Conversation

ong6 commented Feb 24, 2022• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryoarmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryoarmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ryoarmanda left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ryoarmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ryoarmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

ryoarmanda left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

tlylt left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ong6 commented Feb 24, 2022•
edited
Loading

ryoarmanda left a comment •
edited
Loading