AppFlowy-IO / AppFlowy-IO/AppFlowy-Docs

Redundancy or wording issue

Open
#187 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/f3bd77d309ab693d4c572468ff6a866ae11ee4f9/documentation/appflowy/troubleshooting.md?plain=1#L27

Inaccuracy 1: It uses the verb `are` twice, which is redundant.
Inaccuracy 2: `that` is missing and to make the sentence grammatically correct.
After adding `that`: Here are the files `that` are safe to remove

However, the sentence has awkward phrasing and it sounds unnatural if we add `that`.

I suggest:
"These files are safe to remove."
"You can safely remove these files."

Contributor guide

No contributing guide indexed for this repository

Research direction

Open documentation/appflowy/troubleshooting.md at line 27 and review the sentence about files that are safe to remove. Replace the redundant, awkward wording with a grammatically correct alternative from the issue, then verify the rendered documentation uses the intended 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
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.