AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

3 different inaccuracies

Open
#206 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
109
Forks
108
PR merge metrics
No merged PRs in 30d

Description

https://github.com/AppFlowy-IO/AppFlowy-Docs/blob/b058a9f9a63da5b2afa4b78f2bbb7c9401c5b9f4/essential-documentation/contribute-to-appflowy/appflowy-mentorship-program/mentorship-2022/mentee-projects/table.md?plain=1#L11

### Inaccurate ###
"Appflowy"
### Accurate ###
"AppFlowy"
Proper nouns should be capitalized correctly. "AppFlowy" as an official name should be consistently capitalized. I encountered this capitalization issue often in the documentation but as it coincides with other inaccuracies in this sentence I suggested to fix it. The same thing for GitHub which is not always capitalized consistently.

### Inaccurate ###
"aims implementing"
### Accurate ###
"aims `to` implement"
The verb "aims" should be followed by an infinitive ("to implement") rather than a gerund ("implementing").

### Inaccurate ###
"basic tabular content feature"
### Accurate ###
"`a` basic tabular content feature"
Adding the article "a" makes the sentence grammatically complete and more natural.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open essential-documentation/contribute-to-appflowy/appflowy-mentorship-program/mentorship-2022/mentee-projects/table.md at the linked line 11 and review the sentence containing the three reported inaccuracies. Correct the AppFlowy and GitHub capitalization, change “aims implementing” to “aims to implement,” and add the missing article; done means all three wording issues are fixed in that sentence.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.