AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Punctuation, Grammar, and Clarity Issues

Open
#222 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#L127

***Clarity***
Inaccurate:
"We `are` imported from level 3 to level 1."
Accurate:
"`Pages` are imported from level 3 to level 1." From the context it seems that we need to add `Pages`

Inaccurate:
"This is done `because` to handle the subpages ."
Accurate:
"This is done to handle the subpages."

***Punctuation & Grammar***
Inaccurate:
"We use markdownToDocument function of appflowy-editor package to `chick` we pass the markdown content`s` of our page and `it return` us a Document."
Accurate:
"We use `the` markdownToDocument function of the appflowy-editor package`: to check` we pass the markdown content of our page`,` and `it returns` a Document."

***Plural & Punctuation***
Inaccurate:
"We also pass a custom-parser to this function which handles our subpage."
Accurate:
"We also pass a `custom parser` to this function`,` which handles our `subpages`."

***Grammar & Punctuation***
Inaccurate:
"Whenever it detects a subpage it `replace` the part with...
Accurate:
"Whenever it detects a subpage`,` it `replaces` .....

***Grammar***
Inaccurate:
"When above level are being imported and `there` contents are passed through
Accurate:
"When above level are being imported and `their` contents are passed

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.