AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Repetition, consistency, formatting and tense inaccuracies

Open
#219 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/25b257ed20e86ededcf0337049fc07d7247d6e34/essential-documentation/contribute-to-appflowy/appflowy-mentorship-program/mentorship-2022/mentee-projects/importers.md?plain=1#L114

***1. Unnecessary Repetition & Informal Phrase***
Inaccurate:
"`Like For` example" → "Like" and "For example" serve the same purpose; using both is redundant.
Accurate:
Use either "For example" or "Like" (though "For example" is more formal).

***2. Comma Misplacement & Formatting***
Inaccurate:
"the main page will be level 1` , `if it has a subpage it will be level 2" → Incorrect comma placement
Accurate:
"the main page will be level 1`. `If it has a subpage`,` it will be level 2."

***3. Tense & Consistency***
Inaccurate:
"if that subpage `will have` another subpage that `would belong` to level 3" → "will have" and "would belong" mix future and conditional tense.
Accurate:
should be "if that subpage `has` another subpage`, it will` belong to level 3."

Also, please ensure that level 1, level 2, and level 3 are consistently formatted, either using numerals (1, 2, 3) or written out in words (One, Two, Three).

Contributor guide

No contributing guide indexed for this repository

Research direction

Open essential-documentation/contribute-to-appflowy/appflowy-mentorship-program/mentorship-2022/mentee-projects/importers.md at the linked section around line 114. Review the listed repetition, punctuation, tense, and level-formatting issues, then verify the wording is consistent and grammatically correct throughout that passage.

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
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.