hslink: update doc #44
Conversation
WalkthroughThe documentation has been restructured to remove the “支持特性” section and add a new “上位机配置项” section. The update introduces various host configuration options such as speed boost, SWD/JTAG output modes, reference voltage management, power/IO outputs, default reset mode, and LED settings. In addition, the document now details using the host computer for firmware upgrades (both Bootloader and application) and includes updated FAQ clarifications regarding power and signal outputs. Changes
Sequence Diagram(s)sequenceDiagram
participant User as User
participant Host as Host Computer
participant Device as Device Firmware
User->>Host: Initiate Firmware Upgrade
Host->>Device: Upgrade Bootloader
Device-->>Host: Bootloader Upgrade Result
Host->>Device: Upgrade Application
Device-->>Host: Application Upgrade Result
Host-->>User: Report Upgrade Results
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 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 (2)
docs/src/projects/HSLink Pro.md (2)
9-30: Clarify the Retention of the “支持特性” Section
The AI summary indicates that the “支持特性” section should be removed in favor of the new “上位机配置项” section. However, this section is still present from lines 9 to 30. Please verify whether this legacy section is intended to remain or if it should be eliminated to avoid confusing users.
61-83: Enforce Consistent Markdown Unordered List Style
The new “上位机配置项” section (lines 61–83) uses asterisks (“*”) for unordered lists, while other list sections (e.g. in “支持特性”) use dashes (“-”). For consistency and to comply with markdownlint MD004 recommendations, please update these list markers to dashes. For example:-* 速度Boost + - 速度BoostApply similar replacements for all bullet items in this section (lines 63, 65, 69, 72, 76, 79, and 82).
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
63-63: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
64-64: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
65-65: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
66-66: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
67-67: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
69-69: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
73-73: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
74-74: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
76-76: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
77-77: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
79-79: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
80-80: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
82-82: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
83-83: Unordered list style
Expected: dash; Actual: asterisk(MD004, ul-style)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/src/projects/HSLink Pro.md(3 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/src/projects/HSLink Pro.md
63-63: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
64-64: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
65-65: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
66-66: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
67-67: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
69-69: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
70-70: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
72-72: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
73-73: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
74-74: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
76-76: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
77-77: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
79-79: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
80-80: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
82-82: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
83-83: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (2)
docs/src/projects/HSLink Pro.md (2)
104-107: Review the “回退” Section Text
The “回退” section (lines 104–107) now clearly explains the rollback procedure and includes a caution about the lack of thorough testing. The instructions are clear, but please double-check if the punctuation (e.g. ending sentences with a period) and formatting are consistent with the rest of the document.
108-111: Validate the Firmware Upgrade Instructions
The “使用上位机升级” section (lines 108–111) details the upgrade process for Bootloader and App. The steps are clearly laid out. Please verify that the provided links and button instructions match the latest application behavior.
2 participants
Summary by CodeRabbit