Docs: Fix feishu subscription mode description#150
Conversation
📝 WalkthroughWalkthroughDocumentation updated to reflect Feishu channel integration using WebSocket persistent connection mode instead of HTTP webhook event subscription. Descriptions of architecture, API references, and setup instructions modified to align with the new connection approach. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
main/channels/feishu/README.md (1)
55-59: Consider adding a language specifier to the fenced code block.The architecture diagram accurately depicts the WebSocket-based communication pattern. For markdown lint compliance, consider adding a language specifier (e.g.,
textorplaintext) to the code fence on line 55.📝 Proposed fix
-``` +```text Feishu Server (wss://open.feishu.cn)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@main/channels/feishu/README.md` around lines 55 - 59, The fenced code block that contains "Feishu Server (wss://open.feishu.cn)" should include a language specifier to satisfy markdown linting; edit the opening triple-backtick for that block (the ``` before "Feishu Server (wss://open.feishu.cn)") and add a language token such as text or plaintext (e.g., ```text) so the block is explicitly typed.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@main/channels/feishu/README.md`:
- Around line 55-59: The fenced code block that contains "Feishu Server
(wss://open.feishu.cn)" should include a language specifier to satisfy markdown
linting; edit the opening triple-backtick for that block (the ``` before "Feishu
Server (wss://open.feishu.cn)") and add a language token such as text or
plaintext (e.g., ```text) so the block is explicitly typed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 1dfd6cae-2caa-42a2-9c35-7a03825f58c5
📒 Files selected for processing (2)
main/channels/feishu/README.mdmain/cli/serial_cli.c
There was a problem hiding this comment.
🧹 Nitpick comments (2)
main/channels/feishu/README.md (2)
55-69: Architecture diagram accurately reflects WebSocket persistent connection.The updated architecture clearly shows the WebSocket-based flow with ESP32 initiating the connection, which aligns with the persistent connection mode described in the setup instructions.
Optional: Specify language for code fence to satisfy linter.
The static analysis tool flags the code fence at line 55 for missing a language specification. Consider adding
textto satisfy the linter.🔧 Optional linter fix
-``` +```text Feishu Server (wss://open.feishu.cn)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@main/channels/feishu/README.md` around lines 55 - 69, The markdown code fence in the Feishu architecture diagram lacks a language tag causing the linter warning; update the fenced block around the ASCII diagram (the block that starts with "Feishu Server (wss://open.feishu.cn)" in main/channels/feishu/README.md) to include a language identifier such as text (e.g., change ``` to ```text) so the linter stops flagging it.
48-51: Consider adding brief UI guidance for setting persistent connection mode.Step 4 instructs users to "Set subscription mode to Persistent connection" but doesn't specify where in the Feishu platform UI this setting is located. Users unfamiliar with Feishu might benefit from a brief note like "In Event Subscription settings" or similar guidance.
📝 Optional enhancement for clarity
4. Configure Event Subscription: - - Set subscription mode to **Persistent connection** (长连接) + - In Event Subscription settings, set subscription mode to **Persistent connection** (长连接) - Subscribe to: `im.message.receive_v1`🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@main/channels/feishu/README.md` around lines 48 - 51, Step 4's instruction to "Set subscription mode to **Persistent connection**" lacks UI context; update the README's Configure Event Subscription section to briefly show where to change this in the Feishu console (e.g., open your app in Feishu Developer Console → Event Subscription settings → set Mode to "Persistent connection (长连接)"), and explicitly mention subscribing to the `im.message.receive_v1` event so users know which UI field to update; keep the note short and place it next to the existing step for clarity.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@main/channels/feishu/README.md`:
- Around line 55-69: The markdown code fence in the Feishu architecture diagram
lacks a language tag causing the linter warning; update the fenced block around
the ASCII diagram (the block that starts with "Feishu Server
(wss://open.feishu.cn)" in main/channels/feishu/README.md) to include a language
identifier such as text (e.g., change ``` to ```text) so the linter stops
flagging it.
- Around line 48-51: Step 4's instruction to "Set subscription mode to
**Persistent connection**" lacks UI context; update the README's Configure Event
Subscription section to briefly show where to change this in the Feishu console
(e.g., open your app in Feishu Developer Console → Event Subscription settings →
set Mode to "Persistent connection (长连接)"), and explicitly mention subscribing
to the `im.message.receive_v1` event so users know which UI field to update;
keep the note short and place it next to the existing step for clarity.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: c14a7317-3e58-443f-8bf9-0c5e971c2388
📒 Files selected for processing (1)
main/channels/feishu/README.md
IRONICBo
added
documentation
3 participants
Docs: Fix feishu subscription mode description
Summary by CodeRabbit