docs: 更新 README 文件结构和内容#300
Conversation
- 统一文字，英文文档中不应该出现中文字符 - 在 README.md 中添加简体中文和繁体中文版本的链接 - 重新组织 README.md 的结构，优化标题层级 - 删除冗余的空行和不必要的标点符号
- 统一文字，英文文档中不应该出现中文字符 - 在 README.md 中添加简体中文和繁体中文版本的链接 - 重新组织 README.md 的结构，优化标题层级 - 删除冗余的空行和不必要的标点符号
WalkthroughThis update refines both the English and Simplified Chinese README documents. A language selection line has been added at the top of each file, and section headers have been updated to include "CherryUSB" for clarity. Several punctuation and formatting corrections have been applied to improve readability. No changes were made to exported or public declarations. Changes
Poem
🪧 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 (
|
- 调整表格格式，使其更加规范和易读
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
README_zh-TW.md (1)
94-94: Inconsistency in Host Stack terminology.
In this file the Host Stack overview section refers to “挂載在 root hub、外部 hub 上”, whereas in the Simplified Chinese version the term has been updated to “root WEBUSBhub”. For consistency—and in line with the PR objective—it is advisable to update the Traditional Chinese version to also reflect “root WEBUSBhub”.README.md (4)
29-30: Consider revising “Easy to study USB.”
The current subheading “### Easy to study USB” seems slightly awkward. Consider rephrasing it as “### Easy to learn USB” to better reflect the intended meaning.
64-65: Grammar improvement needed for callback description.
The phrase “…let users do whatever they wants in endpoint irq callback.” contains a subject–verb agreement error. It is recommended to change “wants” to “want” (or rephrase the sentence for clarity, e.g., “…allowing users to perform any desired operations within the endpoint IRQ callback”).Proposed diff:
- Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback. + Support endpoint IRQ callback registration by users, allowing them to perform any desired operations within the IRQ callback.🧰 Tools
🪛 LanguageTool
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...(NON3PRS_VERB)
92-96: Host Stack terminology and article usage refinement.
While the Host Stack overview is comprehensive, note the following points for improved consistency and clarity:
- The description currently states “devices mounted on root hubs and external hubs.” To align with the changes in other versions and the PR objective, consider changing “root hubs” to “root WEBUSBhub”.
- Additionally, the text phrase “managed using os” could be improved by capitalizing “OS” and using the appropriate article (e.g., “managed using an OS”).
Proposed diff snippet for terminology and article adjustment:
- ... for devices mounted on root hubs and external hubs, and a standard interface ... + ... for devices mounted on root WEBUSBhub and external hubs, and a standard interface ...- Finally, the host stack is managed using os, and provides osal to make a adaptation for different os. + Finally, the host stack is managed using an OS, and provides osal to adapt to different operating systems.🧰 Tools
🪛 LanguageTool
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...(EN_A_VS_AN)
181-182: Graphical Config Tool description check.
The explanation for the configurator tool is clear. If desired, consider capitalizing known acronyms (e.g., “Electron” and “Vite2”) to reflect standard naming conventions.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(9 hunks)README_zh-CN.md(6 hunks)README_zh-TW.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...
(NON3PRS_VERB)
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...
(EN_A_VS_AN)
🔇 Additional comments (13)
README_zh-CN.md (6)
1-2: Language selection links added.
The new top line with links to English, Simplified Chinese, and Traditional Chinese versions improves navigation and makes the document more accessible.
11-11: Product description clarity maintained.
The description “CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统（带 USB IP）的高性能 USB 主从协议栈” is clear and concise, effectively introducing the project.
15-15: Enhanced heading for feature emphasis.
Updating the heading to “## 为什么选择 CherryUSB” clearly emphasizes the value propositions for users.
94-94: Updated Host Stack terminology.
The segment now reads “…挂載在 root WEBUSBhub、外部 hub 上…” which correctly replaces the generic “root hub” with “root WEBUSBhub” as specified. This aligns the terminology across documentation versions.
173-173: Documentation Tutorial link is in place.
Including the link to CherryUSB Documentation Tutorial provides readers with a direct route to deeper technical materials.
175-178: Video tutorial section updates.
The video tutorial items now list updated references with clear version notes. This section’s format and content are now consistent and informative.README_zh-TW.md (4)
1-2: Language selection links consistent.
The addition of language selection links at the top—linking to English and Simplified Chinese—with “繁體中文” as the current document is well implemented.
11-11: Concise project introduction.
The description “CherryUSB 是一款小巧精美、可移植性高的高效能 USB 主從協議棧，適用於內建 USB IP 的嵌入式系統” reads naturally and suits the Traditional Chinese audience.
15-15: Improved heading for user guidance.
The header “## 為何選擇 CherryUSB” effectively highlights the project’s key benefits.
173-174: Tutorial sections are clear.
The sections for 文檔教程 and 視頻教程 continue to direct users to valuable resources. The content is consistent with other language versions.README.md (3)
1-2: Language selection navigation improved.
The top line now includes links to the Chinese versions—[简体中文] and [繁體中文]—which enhances usability for a multilingual audience.
15-15: Updated heading improves clarity.
Changing the heading to “## Why choose CherryUSB” clearly specifies the project's benefit statement.
223-224: Closing acknowledgment is well formatted.
The “Company Support” section thanks the supporting companies appropriately and the inclusion of logos adds a professional touch.
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
README_zh-TW.md (2)
1-2: Language Selection Header Looks GoodThe header includes links to the English, Simplified Chinese, and Traditional Chinese versions. Since this is the Traditional Chinese documentation, the presence of Chinese characters is expected and appropriate.
133-152: Macro Definitions Code SnippetsThe fenced code blocks displaying macro definitions look clear. For improved readability and syntax highlighting, consider adding a language identifier (e.g.,
c) to these code blocks.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README_zh-CN.md(6 hunks)README_zh-TW.md(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README_zh-CN.md
🔇 Additional comments (17)
README_zh-TW.md (17)
11-14: Project Description and LogoThe description and logo are clear and appropriately convey the nature of CherryUSB. No issues detected in this section.
15-25: “為何選擇 CherryUSB” SectionThis section is well-organized and uses bullet points effectively to outline the advantages of using CherryUSB. The content is clear and informative.
26-32: “易於使用 USB” SectionThe benefits of the USB interface usage are concisely listed and easy to read. The description aligns well with user expectations.
33-42: “發揮 USB 的最佳效能” SectionThe performance benefits are clearly described, emphasizing important features such as direct register access and DMA utilization.
43-56: 目錄結構 TableThe directory structure table is neatly formatted and provides a clear overview of the project layout.
57-91: Device 協議棧簡介 Section and Resource UsageThis section offers a comprehensive description of the Device protocol stack, along with a detailed resource usage table. The content is thorough and well-structured.
92-116: Host 協議棧簡介 OverviewThe introduction and description of the Host protocol stack are well articulated, outlining key features and the implementation strategy clearly.
117-132: Host 協議棧資源占用說明 TableThe resource usage table for the Host stack is clear and provides technical details in an organized manner.
153-170: USB IP 支持情況 SectionThe table listing the USB IP support details is well-organized and informative, clearly indicating the support status for both device and host functionalities.
171-174: 文檔教程 SectionThis segment directs users to additional documentation resources effectively. The provided link is useful for readers who want to learn more about CherryUSB.
175-179: 視頻教程 SectionThe video tutorials are clearly listed with relevant links, offering additional guidance on the usage and features of CherryUSB.
180-183: 圖形化界面配置工具 SectionThe section introducing the configuration tool is concise and specifies the technology stack used (electron, vite2, ts), which is beneficial for the target audience.
184-203: 示例倉庫 TableThe examples table is extensive and well-formatted, providing detailed information on manufacturers, supported USB IPs, and repository links. This is a valuable resource for users.
204-210: 軟件包支持 SectionThe section on software package support is straightforward and effectively lists the available resources.
211-213: 商業支持 SectionThis segment succinctly presents the commercial support information with a direct reference link, which is appropriate for users seeking additional assistance.
214-216: 聯系 SectionThe contact details are clear and provide an easy way for users to get in touch with the project community.
217-227: 支持企業 SectionThe supported companies’ section effectively uses logo images to visually represent enterprise backers. This enhances the credibility of the project.
- 修复docs中没有正确闭合的标签
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
README_zh-CN.md (2)
5-8: Improve Badge Section Accessibility and Formatting
The anchor elements for badges currently use hard tabs and lack descriptive alt text. To comply with markdownlint guidelines and to improve accessibility, please replace hard tabs with spaces and add alt attributes to the images. For example:- <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg"></a> + <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg" alt="Release Badge"></a>🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Hard tabs
Column: 1(MD010, no-hard-tabs)
5-5: Images should have alternate text (alt text)
null(MD045, no-alt-text)
6-6: Hard tabs
Column: 1(MD010, no-hard-tabs)
6-6: Images should have alternate text (alt text)
null(MD045, no-alt-text)
7-7: Images should have alternate text (alt text)
null(MD045, no-alt-text)
8-8: Images should have alternate text (alt text)
null(MD045, no-alt-text)
177-178: Wrap Bare URLs in Video Tutorial Section
The video tutorial items include bare URLs. Wrapping these URLs in markdown link syntax will improve readability and consistency. For example:- - USB 基本知识点与 CherryUSB Device 協議棧是如何編寫的（使用 v0.4.1 版本），參考 https://www.bilibili.com/video/BV1Ef4y1t73d 。 + - USB 基本知识点与 CherryUSB Device 協議棧是如何編寫的（使用 v0.4.1 版本），參考 [Bilibili Video](https://www.bilibili.com/video/BV1Ef4y1t73d) 。🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
177-177: Bare URL used
null(MD034, no-bare-urls)
178-178: Bare URL used
null(MD034, no-bare-urls)
README_zh-TW.md (2)
5-8: Enhance Badge Section Accessibility in Traditional Chinese Version
Similar to the Simplified Chinese version, consider replacing hard tabs with spaces and adding descriptive alt attributes in thetags. For example:
- <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg"></a> + <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg" alt="Release Badge"></a>
177-178: Update Bare URLs in Video Tutorial Section
To maintain consistency and improve readability, please wrap the bare URLs present in the video tutorial section with markdown link syntax. For example:- - USB 基本知識點與 CherryUSB Device 協議棧是如何編寫的（使用 v0.4.1 版本），參考 https://www.bilibili.com/video/BV1Ef4y1t73d 。 + - USB 基本知識點與 CherryUSB Device 協議棧是如何編寫的（使用 v0.4.1 版本），參考 [Bilibili Video](https://www.bilibili.com/video/BV1Ef4y1t73d) 。README.md (3)
5-8: Improve Badge Section for Enhanced Accessibility
As with the Chinese README files, please replace hard tabs with spaces and add appropriate alt text for the badge images for improved accessibility and markdownlint compliance. For example:- <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg"></a> + <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg" alt="Release Badge"></a>
63-64: Correct Grammar in Endpoint Callback Description
The sentence “Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback.” contains grammatical issues. Consider rewriting it as follows:- Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback. + Support endpoint IRQ callback registration for users, allowing them to handle the callback as needed.🧰 Tools
🪛 LanguageTool
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...(NON3PRS_VERB)
92-94: Improve Article Usage for Clarity
In the host stack overview, please replace “a adaptation” with “an adaptation” and consider clarifying the sentence. For example:- and provides osal to make a adaptation for different os. + and provides an OS abstraction layer (osal) to adapt to different operating systems.🧰 Tools
🪛 LanguageTool
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...(EN_A_VS_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
README.md(8 hunks)README_zh-CN.md(5 hunks)README_zh-TW.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...
(NON3PRS_VERB)
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...
(EN_A_VS_AN)
🪛 markdownlint-cli2 (0.17.2)
README_zh-CN.md
5-5: Hard tabs
Column: 1
(MD010, no-hard-tabs)
5-5: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
6-6: Hard tabs
Column: 1
(MD010, no-hard-tabs)
6-6: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
7-7: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
8-8: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
177-177: Bare URL used
null
(MD034, no-bare-urls)
178-178: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (4)
README_zh-CN.md (1)
1-2: Language Selection Section Verification
The addition of a language selection link at the top makes it easy for users to navigate between English, Simplified Chinese, and Traditional Chinese versions.README_zh-TW.md (1)
1-2: Confirm Language Selection Section
The updated language selection at the top now correctly links to the available language versions and is clear for the users.README.md (2)
1-2: Language Selection Header Added
The new language selection line at the top now clearly directs users to the English, Simplified Chinese, and Traditional Chinese versions of the document.
95-224: Overall Document Clarity and Consistency
The updated README.md now has improved headings, punctuation, and standardized language throughout. The changes effectively enhance clarity and accessibility while preserving the technical details and intended content.🧰 Tools
🪛 LanguageTool
[uncategorized] ~98-~98: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...ions: - Support low speed, full speed, high speed and super speed devices - Automatic loa...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[grammar] ~199-~199: Did you mean the abbreviation for “I don’t know”?
Context: ...ncorp | bk7256/bk7258 | musb |bk_idk| ...(IDK)
|
不加繁体 |
已添加修改 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
62-64: Grammar Correction in Bullet Item
The bullet point under “CherryUSB Device Stack has the following functions:” currently reads:- Support endpoint irq callback register by users, let users do whatever they wants in endpoint irq callback.For grammatical correctness, change "they wants" to "they want" to properly agree with the plural subject “users”.
Proposed change:
- ...let users do whatever they wants in endpoint irq callback. + ...let users do whatever they want in endpoint irq callback.🧰 Tools
🪛 LanguageTool
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...(NON3PRS_VERB)
92-94: Article Correction in Host Stack Overview
In the Host Stack Overview, the sentence “...provides osal to make a adaptation for different os.” should use “an adaptation” instead of “a adaptation” because “adaptation” starts with a vowel sound. Additionally, consider capitalizing “os” and “osal” for consistency if they refer to operating systems.Proposed change:
- provides osal to make a adaptation for different os. + provides osal to make an adaptation for different os.🧰 Tools
🪛 LanguageTool
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...(EN_A_VS_AN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(8 hunks)README_zh-CN.md(5 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- README_zh-CN.md
🧰 Additional context used
🪛 LanguageTool
README.md
[grammar] ~64-~64: The pronoun ‘they’ must be used with a non-third-person form of a verb.
Context: ...er by users, let users do whatever they wants in endpoint irq callback. - Support Com...
(NON3PRS_VERB)
[misspelling] ~94-~94: Use “an” instead of ‘a’ if the following word starts with a vowel sound, e.g. ‘an article’, ‘an hour’.
Context: ...ged using os, and provides osal to make a adaptation for different os. CherryUSB...
(EN_A_VS_AN)
🔇 Additional comments (2)
README.md (2)
1-1: Language Selection Link Clarity
The language selection line now only includes a link for the Simplified Chinese version (“简体中文”). This aligns with the feedback (“不加繁体”) and helps standardize the language options in the documentation.
15-15: Header Improvement
Changing the header from "Why choose" to "Why choose CherryUSB" clearly establishes the context and reinforces the project name.
|
README_zh-CN 保持默认 README_zh |
@sakumisu 已修改 |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
README_zh.md (4)
5-8: Indentation & Image ALT Attributes – Replace Hard Tabs and Add Alt TextStatic analysis has flagged hard tabs and missing alternate text for images. Consider replacing the tab characters with spaces and including alt text for each image for better accessibility. For example:
- <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg"></a> + <a href="https://github.com/cherry-embedded/CherryUSB/releases"><img src="https://img.shields.io/github/release/cherry-embedded/CherryUSB.svg" alt="GitHub Release Badge"></a>Apply similar changes for the LICENSE, deploy-docs, and Discord badges.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
5-5: Hard tabs
Column: 1(MD010, no-hard-tabs)
5-5: Images should have alternate text (alt text)
null(MD045, no-alt-text)
6-6: Hard tabs
Column: 1(MD010, no-hard-tabs)
6-6: Images should have alternate text (alt text)
null(MD045, no-alt-text)
7-7: Images should have alternate text (alt text)
null(MD045, no-alt-text)
8-8: Images should have alternate text (alt text)
null(MD045, no-alt-text)
102-102: Multi-level HUB Detail – Consider Simplifying Parenthetical ExplanationThe current line:
- 支持多级 HUB，最高可拓展到 7 级(目前测试 1拖 10 没有问题，仅支持 dwc2/ehci/xhci/rp2040)includes extra parenthetical details that may overwhelm the reader. To align with the goal of clarity and conciseness, consider simplifying it. For example:
- 支持多级 HUB，最高可拓展到 7 级(目前测试 1拖 10 没有问题，仅支持 dwc2/ehci/xhci/rp2040) + 支持多级 HUB，最高可拓展到 7 级This will remove potentially redundant details while still conveying the key point.
175-175: Video Tutorial Link (v0.4.1) – Convert Bare URL to Markdown LinkThe video tutorial for “USB 基本知识点与 CherryUSB Device 协议栈是如何编写的” is referenced by a bare URL. To improve consistency and satisfy markdown lint rules, convert the bare URL into a markdown link. For example:
- - USB 基本知识点与 CherryUSB Device 协议栈是如何编写的（使用 v0.4.1 版本），参考 https://www.bilibili.com/video/BV1Ef4y1t73d 。 + - USB 基本知识点与 CherryUSB Device 协议栈是如何编写的（使用 v0.4.1 版本），参考 [视频链接](https://www.bilibili.com/video/BV1Ef4y1t73d)。This improves readability and complies with MD034.
176-176: Video Tutorial Link (v1.1.0) – Convert Bare URL to Markdown LinkSimilarly, update the Traditional Chinese meeting tutorial reference from a bare URL to a formatted markdown link:
- - CherryUSB 腾讯会议（使用 v1.1.0 版本），参考 https://www.bilibili.com/video/BV16x421y7mM 。 + - CherryUSB 腾讯会议（使用 v1.1.0 版本），参考 [视频链接](https://www.bilibili.com/video/BV16x421y7mM)。This adheres to markdown best practices.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README_zh.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README_zh.md
5-5: Hard tabs
Column: 1
(MD010, no-hard-tabs)
5-5: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
6-6: Hard tabs
Column: 1
(MD010, no-hard-tabs)
6-6: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
7-7: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
8-8: Images should have alternate text (alt text)
null
(MD045, no-alt-text)
177-177: Bare URL used
null
(MD034, no-bare-urls)
178-178: Bare URL used
null
(MD034, no-bare-urls)
🔇 Additional comments (5)
README_zh.md (5)
1-1: Language Selection Line – Appropriate InclusionThe addition of the language selection line
**[English](README.md) | 简体中文**clearly provides a switch between the English and Simplified Chinese versions. This meets the PR objective while keeping the Chinese version for localization purposes.
11-11: Punctuation & Description – Consistent FormattingThe updated description:
CherryUSB 是一个小而美的、可移植性高的、用于嵌入式系统（带 USB IP）的高性能 USB 主从协议栈。now uses full-width punctuation for parentheses, which increases readability.
15-15: Section Heading – Clarified TitleUpdating the heading to “## 为什么选择 CherryUSB” makes the title more descriptive and consistent with the branding.
94-94: Host Protocol Stack Description – Improved ClarityThe updated paragraph on line 94 provides a clearer description of the host protocol stack’s design and integration (including hcd porting and osal usage). This enhances the overall documentation quality.
173-173: Documentation Tutorial Link – Clear and AccessibleThe documentation tutorial line:
CherryUSB 快速入门、USB 基本概念、API 手册、Class 基本概念和例程，参考 [CherryUSB Documentation Tutorial](https://cherryusb.readthedocs.io/)。uses a proper markdown link format, making it both accessible and neatly presented.
2 participants
Summary by CodeRabbit