What is Wechaty sub-section of the Introduction section

[nibble0101]

Improve the Introduction and Explanation sections project

Section	Sub-section	Technical Writer
Introduction	What is Wechaty	Joseph Mawa

This is What is Wechaty sub-section of the Introduction section

[proudofsimin]

Overall your documentation is really great! I point out some minor corrections and hope we could make it better together!

[huan]

Thanks to @proudofsimin for your great review & suggestions of how to follow the Google Developer Documentation Style Guide!

It's very important for our docs to follow those guides because we must be consistent across all docs, especially we have many writers work together.

I'm thinking about whether we can find a linter (linting tool) for enforce those documentation styles, would love to add it to our CI system if there's any.

[iamrajiv]

Hi @huan, I don't think there is a linter that follows the Google developer documentation style guide, but for programming languages, there are separate linters, but I don't think we need that.

So we have to make our linter according to the Google developer documentation style guide, but that would be very hard and can be considered a long process. So as of now, I would suggest making a separate markdown file that lists all the style guide to follow for Wechaty.

In addition to it, I want to add some miscellaneous points which can make the Wechaty workflow better:

• Adding linter to removed unnecessary indentations across all the docs file. There are so many files that have indentations like this (highlighted)

• Adding Prettier support for markdown files. Prettier is an opinionated code formatter. It removes all original styling and ensures that all outputted code conforms to a consistent style. (See this blog post).
• Adding spell check GitHub action.
• Adding GitHub action for translating Non-English issues content to English. For example, there are Non-English issues like #161. This action will convert that to English.

[proudofsimin]

Thanks to @proudofsimin for your great review & suggestions of how to follow the Google Developer Documentation Style Guide!

It's very important for our docs to follow those guides because we must be consistent across all docs, especially we have many writers work together.

I'm thinking about whether we can find a linter (linting tool) for enforce those documentation styles, would love to add it to our CI system if there's any.

Hi @huan,

Very great suggestions! but unfortunately I didn't find it.
Like Rajiv suggested, if we could import grammar or spelling check, that would be awesome.

[proudofsimin]

fantastic!

[Rohitesh-Kumar-Jain]

Looks good to me, great work

[Rohitesh-Kumar-Jain]

ping @huan

[lijiarui]

hi @Rohitesh-Kumar-Jain As GSoD Project PR Review Rules in https://github.com/wechaty/wechaty.js.org/issues/1045

This PR should follow our rules and get enough approval, then I will review this PR. So I remove the ready to merge tag and feel free to add this tag when it gets enough approval.

[proudofsimin]

hi @Rohitesh-Kumar-Jain As GSoD Project PR Review Rules in #1045

This PR should follow our rules and get enough approval, then I will review this PR. So I remove the ready to merge tag and feel free to add this tag when it gets enough approval.

Hi @chris-4444 Wechaty committee requested review from teammates. Could you review/ sign off it and add a tag ready to merge after you finish? Thank you.

[nibble0101]

Hi @nibble0101

The first one is what we wrote and the second is what was originally in the docs. I think we can remove the second one.

I thinks instead of remove the origin part, you should merge them together, also remember to use mdx file here.

Well. I have merged the two files and changed it to .mdx

[huan]

LGTM

@nibble0101 Thank you very much for this great PR!

@proudofsimin @Rohitesh-Kumar-Jain @chris-4444 Thank you very much for the review comments and the approvals.

This PR has been in the queue for a long time, and it has already fulfilled the requirements to be merged with three approvements:

1. Approved by the teammate (+1)
2. Approved by the volunteer team (+2)

Could you please help yourself to merge this PR for the community?

And I'd like to encourage all of our technical writers to merge a PR for the community, whenever the PR has fulfilled the requirements, and you believe it's good to be merged.

Thank you very much!

[nibble0101]

@Rohitesh-Kumar-Jain Can you merge this? I have failed to merge because either the base branch is protected or because I am the one who opened the PR. I am not exactly sure why.

[huan]

I noticed that @lijiarui has required changes and it might be the blocker of merging this PR.

@nibble0101 Could you please resolve the change request from @lijiarui and ask her to approve this PR and try again to merge?

[nibble0101]

I noticed that @lijiarui has required changes and it might be the blocker of merging this PR.

@nibble0101 Could you please resolve the change request from @lijiarui and ask her to approve this PR and try again to merge?

I have worked on the issues she raised and even requested another review from her.

[huan]

ping @lijiarui

[lijiarui]

Please change the IM name, then I will approve this PR. Thanks!