docs: update README #189
docs: update README #189
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request involves documentation updates for the Fluent Editor's README files in both English and Chinese. The changes focus on refining language, improving clarity, and ensuring consistent terminology. Key modifications include simplifying feature descriptions, adjusting term usage (e.g., "table" instead of "tables"), and adding a visual representation through an image reference. The updates aim to enhance the readability and presentation of the project documentation. Changes
Possibly related PRs
Suggested reviewers
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
WalkthroughThis pull request updates the README files in both English and Chinese to improve clarity and consistency. Changes include refining descriptions of the Fluent Editor's features and advantages, updating terminology, and adding an image for better visual representation. Changes
|
![petercat-assistant[bot]](https://avatars.githubusercontent.com/in/875736?s=60&v=4){kind=small}
| @@ -6,18 +6,20 @@ | |||
|
|
|||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | |||
|
|
|||
| Fluent Editor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as tables, images, hyperlinks, copy and paste, inserting emoticons, file uploads, @ reminders, and diagonal menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem. | |||
| Fluent Editor is a rich text editor based on Quill 2.0, which extends Quill with rich modules and formats such as table, image, link, clipboard, emoji, file, mention, and quick menu. It is framework-independent, compatible with Quill API, and compatible with Quill module ecosystem. | |||
There was a problem hiding this comment.
Ensure that the terminology changes do not affect the understanding of the features, especially for users familiar with the previous terms.
|
|
||
| <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section --> | ||
|
|
||
| [](#contributors-) | ||
|
|
||
| <!-- ALL-CONTRIBUTORS-BADGE:END --> | ||
|
|
||
| FluentEditor 是一个基于 Quill 2.0 的富文本编辑器，在 Quill 基础上扩展了表格、图片、超链接、复制粘贴、插入表情、文件上传、@提醒、斜杆菜单等丰富的模块和格式，框架无关、兼容 Quill API、兼容 Quill 模块生态。 | ||
| Fluent Editor 是一个基于 Quill 2.0 的富文本编辑器，在 Quill 基础上扩展了表格、图片、超链接、复制粘贴、插入表情、文件上传、@提醒、斜杆菜单等丰富的模块和格式，框架无关、兼容 Quill API、兼容 Quill 模块生态。 |
There was a problem hiding this comment.
Verify that the updated terminology in Chinese aligns with the intended meaning and does not confuse users familiar with the previous terms.
PR
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
Does this PR introduce a breaking change?
Other information
Summary by CodeRabbit