[PR #8084] Update README.md - grammar and writing fixes #8296

New issue

Open

opened 2026-03-23 23:23:31 +00:00 by mirror · 0 comments

mirror commented

2026-03-23 23:23:31 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/AppFlowy-IO/AppFlowy/pull/8084
Author: @oddlittlebird
Created: 6/26/2025
Status: 🔄 Open

Base: main ← Head: patch-1

📝 Commits (2)

e30677e Update README.md
d6cd908 Update README.md

📊 Changes

1 file changed (+14 additions, -15 deletions)

View changed files

📝 README.md (+14 -15)

📄 Description

Feature Preview

This PR makes minor improvements to the README, including:

Make headings consistently sentence case. They were previously some title case and some sentence case.
Replaced vague link text such as "here" with specific link text.
Removed unnecessary bolding.
Added periods to the ends of sentences.
Minor grammar edits.

PR Checklist

[ x] My code adheres to AppFlowy's Conventions
[ yes] I've listed at least one issue that this PR fixes in the description above.
[NA ] I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes.
[ x] All existing tests are passing.

Summary by Sourcery

Update README.md with consistent heading casing, clearer link text, improved punctuation, and minor grammar edits

Documentation:

Normalize all headings to sentence case
Replace vague link text (e.g., "here") with descriptive text
Remove unnecessary bold formatting from the document
Add periods at the end of sentences
Apply minor grammar corrections across the README

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/AppFlowy-IO/AppFlowy/pull/8084 **Author:** [@oddlittlebird](https://github.com/oddlittlebird) **Created:** 6/26/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `patch-1` --- ### 📝 Commits (2) - [`e30677e`](https://github.com/AppFlowy-IO/AppFlowy/commit/e30677eeb67dd0e71b363d678626e8a765bf7125) Update README.md - [`d6cd908`](https://github.com/AppFlowy-IO/AppFlowy/commit/d6cd9084b87c32003ef8f942b655e42a663eadc0) Update README.md ### 📊 Changes **1 file changed** (+14 additions, -15 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+14 -15) </details> ### 📄 Description ### Feature Preview This PR makes minor improvements to the README, including: - Make headings consistently sentence case. They were previously some title case and some sentence case. - Replaced vague link text such as "here" with specific link text. - Removed unnecessary bolding. - Added periods to the ends of sentences. - Minor grammar edits. #### PR Checklist - [ x] My code adheres to [AppFlowy's Conventions](https://docs.appflowy.io/docs/documentation/software-contributions/conventions) - [ yes] I've listed at least one issue that this PR fixes in the description above. - [NA ] I've added a test(s) to validate changes in this PR, or this PR only contains semantic changes. - [ x] All existing tests are passing. ## Summary by Sourcery Update README.md with consistent heading casing, clearer link text, improved punctuation, and minor grammar edits Documentation: - Normalize all headings to sentence case - Replace vague link text (e.g., "here") with descriptive text - Remove unnecessary bold formatting from the document - Add periods at the end of sentences - Apply minor grammar corrections across the README --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>