[PR #900] [MERGED] doc: Editorial updates to the ReadMe for AppFlowyEditor #4418

New issue

Closed

opened 2026-03-23 21:37:43 +00:00 by mirror · 0 comments

mirror commented

2026-03-23 21:37:43 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/AppFlowy-IO/AppFlowy/pull/900
Author: @egp415
Created: 8/24/2022
Status: ✅ Merged
Merged: 9/2/2022
Merged by: @LucasXu0

Base: main ← Head: main

📝 Commits (8)

1836401 Editorial updates to the text
efcfe97 Update README.md
390ff9a Documentation edits to testing
586bed8 Clean up text for customizing
d05af60 doc: fix missing links
26540d0 docs: customizing events
1de4558 docs: fix todos
d94477e docs: fix todos

📊 Changes

3 files changed (+115 additions, -82 deletions)

View changed files

📝 frontend/app_flowy/packages/appflowy_editor/README.md (+37 -24)
📝 frontend/app_flowy/packages/appflowy_editor/documentation/customizing.md (+35 -32)
📝 frontend/app_flowy/packages/appflowy_editor/documentation/testing.md (+43 -26)

📄 Description

Initial update as part of an editorial review of the content of the readme files of this project. Some notes:

• I would suggest adding a short example as to what you might do with an empty editor once it's been instantiated and also showing an actual sample json structure for instantiating the editor, even if it's very simple.

• The Glossary Heading that says to refer to the API documents should provide a link, but I wasn't sure where this location should be.

_{🔄 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/900 **Author:** [@egp415](https://github.com/egp415) **Created:** 8/24/2022 **Status:** ✅ Merged **Merged:** 9/2/2022 **Merged by:** [@LucasXu0](https://github.com/LucasXu0) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (8) - [`1836401`](https://github.com/AppFlowy-IO/AppFlowy/commit/18364015101326e3d181c0688ad5940f77fe4a4b) Editorial updates to the text - [`efcfe97`](https://github.com/AppFlowy-IO/AppFlowy/commit/efcfe9786556f7e6a9bf73a80db7ad45253ed7f9) Update README.md - [`390ff9a`](https://github.com/AppFlowy-IO/AppFlowy/commit/390ff9a5a3f133562d0bc9314ce91cff67637283) Documentation edits to testing - [`586bed8`](https://github.com/AppFlowy-IO/AppFlowy/commit/586bed88b006dbc8711d42272827fd303c3ce8a4) Clean up text for customizing - [`d05af60`](https://github.com/AppFlowy-IO/AppFlowy/commit/d05af60f75d756dfa1dcff2dfaeca0089676b40a) doc: fix missing links - [`26540d0`](https://github.com/AppFlowy-IO/AppFlowy/commit/26540d042a7cfc382575930b3846b43bfbe9acb6) docs: customizing events - [`1de4558`](https://github.com/AppFlowy-IO/AppFlowy/commit/1de4558c601279387e4136ba16f641236f76e4df) docs: fix todos - [`d94477e`](https://github.com/AppFlowy-IO/AppFlowy/commit/d94477e9bfdef5b246752d09cdb6f492bb0e6aad) docs: fix todos ### 📊 Changes **3 files changed** (+115 additions, -82 deletions) <details> <summary>View changed files</summary> 📝 `frontend/app_flowy/packages/appflowy_editor/README.md` (+37 -24) 📝 `frontend/app_flowy/packages/appflowy_editor/documentation/customizing.md` (+35 -32) 📝 `frontend/app_flowy/packages/appflowy_editor/documentation/testing.md` (+43 -26) </details> ### 📄 Description Initial update as part of an editorial review of the content of the readme files of this project. Some notes: • I would suggest adding a short example as to what you might do with an empty editor once it's been instantiated and also showing an actual sample json structure for instantiating the editor, even if it's very simple. • The Glossary Heading that says to refer to the API documents should provide a link, but I wasn't sure where this location should be. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>