feat: better whiteboard svg/mermaid instructions#1097
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughReworks document↔whiteboard collaboration: per-figure routing (mermaid inline vs SVG SubAgent), tightened SubAgent minimal-context and SVG editability rules, updated workflow docs, and added post-insertion preview/export and validation checks. ChangesWhiteboard-Document Collaboration Workflow Redesign
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Warning Review ran into problems🔥 ProblemsStopped waiting for pipeline failures after 30000ms. One of your pipelines takes longer than our 30000ms fetch window to run, so review may not consider pipeline-failure results for inline comments if any failures occurred after the fetch window. Increase the timeout if you want to wait longer or run a 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 |
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Around line 109-110: The markdown link text contains stray whitespace/newline
inside the square brackets around the inline code link
`../../lark-whiteboard/SKILL.md`, triggering MD039; fix it by removing the
spaces/newline so the brackets directly enclose the link text (e.g. replace "[
`../../lark-whiteboard/SKILL.md` ]" with "[`../../lark-whiteboard/SKILL.md`]" or
use a normal link label like "[lark-whiteboard
SKILL](../../lark-whiteboard/SKILL.md)"), updating the occurrence that wraps
`../../lark-whiteboard/SKILL.md`.
- Around line 103-104: The unsupported-features bullet containing the list
"`<radialGradient>` / `<filter>` / `<pattern>` / `<clipPath>` / `<mask>` →
画板都不支持,**请避免使用,否则会导致画板渲染问题**" has its bold markers split across lines;
consolidate the sentence onto one line and place the bold markers so they wrap
only the Chinese phrase "请避免使用,否则会导致画板渲染问题" (e.g. keep the entire warning on a
single line and surround that phrase with ** ... **) to restore proper emphasis
and prevent malformed Markdown rendering.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fdb8f8fd-1a06-4876-8b2b-657d5b27b892
📒 Files selected for processing (1)
skills/lark-doc/references/lark-doc-whiteboard.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1097 +/- ##
==========================================
+ Coverage 67.91% 68.02% +0.11%
==========================================
Files 592 606 +14
Lines 55410 56183 +773
==========================================
+ Hits 37631 38218 +587
- Misses 14669 14798 +129
- Partials 3110 3167 +57 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@60c914af936b62bd18fbd8c4ebe3891dabb1f9f2🧩 Skill updatenpx skills add larksuite/cli#feat/doc_whiteboard_skill -y -g |
b8afdd1 to
7a3371e
Compare
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (3)
skills/lark-doc/references/lark-doc-whiteboard.md (3)
105-105: ⚡ Quick winAdd space after section number.
The heading
3.插入后审查is missing a space after the number. For consistency with other numbered sections, add a space.♻️ Proposed fix
-###### 3.插入后审查 +###### 3. 插入后审查🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 105, The markdown heading "3.插入后审查" is missing a space after the section number; update the heading string to "3. 插入后审查" so it matches the numbering format used elsewhere (locate and edit the heading "3.插入后审查" in lark-doc-whiteboard.md).
87-87: ⚡ Quick winInconsistent heading structure.
This
######heading appears between numbered workflow steps (after "2. 写 SVG" and before "3. 插入后审查") without a number. Consider either:
- Renumbering this as part of the workflow sequence, or
- Making it a sub-section under "2. 写 SVG" with a lower heading level
♻️ Suggested restructure
Option 1 (as sub-section of step 2):
-###### 画板怎么处理 SVG +####### 画板怎么处理 SVGOption 2 (as numbered step in workflow):
-###### 画板怎么处理 SVG +###### 2.1 画板怎么处理 SVG🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 87, The heading "###### 画板怎么处理 SVG" is inconsistent with the numbered workflow between "2. 写 SVG" and "3. 插入后审查"; either convert this heading into a subsection under "2. 写 SVG" by lowering its level (e.g., change from "######" to "###/####" to nest it) or turn it into the next numbered workflow step (rename it to "3. 画板怎么处理 SVG" and update the following step numbering accordingly), and ensure the surrounding steps ("2. 写 SVG" and "3. 插入后审查") are renumbered or adjusted to maintain a consistent sequence.
107-107: ⚡ Quick winClarify which return value contains the board_token.
The phrase "从返回值使用 lark-cli 指令" is vague. Specify that the
board_tokencomes from thedocs +createordocs +updateAPI response.♻️ Proposed fix
-插入画板后,可以从返回值使用 lark-cli 指令,将画板内容导出为 png 图片。若是对设计不满意,可以修改后,删除原来的画板再重新插入,或是调用 [`../../lark-whiteboard/SKILL.md`](../../lark-whiteboard/SKILL.md) 编辑。 +插入画板后,可以从 `docs +create`/`docs +update` 返回的 `board_token` 使用 lark-cli 指令,将画板内容导出为 png 图片。若是对设计不满意,可以修改后,删除原来的画板再重新插入,或是调用 [`../../lark-whiteboard/SKILL.md`](../../lark-whiteboard/SKILL.md) 编辑。🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 107, Clarify that the board_token used with lark-cli to export a whiteboard PNG is returned in the API response body of the docs command (specifically the docs +create and docs +update responses); update the sentence to explicitly state "从 docs +create 或 docs +update 的返回值中获取 board_token,再使用 lark-cli 指令导出为 png" and mention the exact field name board_token and lark-cli usage so readers know where to find the token and which command to run.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Around line 64-65: The bold emphasis markers around the phrase are split
across two lines causing malformed Markdown; fix the bolding by keeping the
emphasized phrase and its surrounding asterisks on a single line so the markers
form a valid pair (e.g., ensure the opening ** and closing ** wrap "这将被视为不及格!"
in the same line). Locate the fragment containing the trailing asterisk after
"极其死板单调, *" and the continuation "**" on the next line and merge them into a
single properly paired bold segment.
- Around line 29-30: The alert is currently written as a bold paragraph "**⚠️
[!IMPORTANT] 分别对每个图表进行决策**" which breaks standard Markdown alert syntax; replace
that bolded inline marker with a proper blockquote alert by putting ">
[!IMPORTANT]" on its own line followed by the alert title/text on the next line
(e.g., "> [!IMPORTANT]\n分别对每个图表进行决策\n如果有多个位置需要插入图表..." ), ensuring the existing
sentence about "步骤 2A 还是 2B" and the guidance about mermaid blocks vs SubAgent
SVG insertion remain as the alert body.
- Around line 101-103: Replace the incorrectly formatted bolded alert header
"**⚠️ [!IMPORTANT] 不支持的装饰特性**" with a proper Markdown callout block starting
with the blockquote callout marker so it becomes a standalone callout line
(e.g., change the line to use "> [!IMPORTANT] ⚠️ 不支持的装饰特性") and ensure the
following list remains as the callout body; update the header text exactly where
the string "**⚠️ [!IMPORTANT] 不支持的装饰特性**" appears in lark-doc-whiteboard.md.
- Line 79: Replace the inline `[!IMPORTANT]` alert with proper Markdown callout
block syntax by putting `> [!IMPORTANT]` at the start of its own line and moving
the following Chinese sentence to the next line (so the alert marker is a
standalone blockquote header and the message text follows on the subsequent
line); update the existing line that currently begins with `[!IMPORTANT] 布局,
配色...` to start with `> [!IMPORTANT]` and ensure the message text remains
immediately after on a new line.
---
Nitpick comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 105: The markdown heading "3.插入后审查" is missing a space after the section
number; update the heading string to "3. 插入后审查" so it matches the numbering
format used elsewhere (locate and edit the heading "3.插入后审查" in
lark-doc-whiteboard.md).
- Line 87: The heading "###### 画板怎么处理 SVG" is inconsistent with the numbered
workflow between "2. 写 SVG" and "3. 插入后审查"; either convert this heading into a
subsection under "2. 写 SVG" by lowering its level (e.g., change from "######" to
"###/####" to nest it) or turn it into the next numbered workflow step (rename
it to "3. 画板怎么处理 SVG" and update the following step numbering accordingly), and
ensure the surrounding steps ("2. 写 SVG" and "3. 插入后审查") are renumbered or
adjusted to maintain a consistent sequence.
- Line 107: Clarify that the board_token used with lark-cli to export a
whiteboard PNG is returned in the API response body of the docs command
(specifically the docs +create and docs +update responses); update the sentence
to explicitly state "从 docs +create 或 docs +update 的返回值中获取 board_token,再使用
lark-cli 指令导出为 png" and mention the exact field name board_token and lark-cli
usage so readers know where to find the token and which command to run.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 6a4d4792-7197-47bf-b5aa-3ff10870c5bb
📒 Files selected for processing (1)
skills/lark-doc/references/lark-doc-whiteboard.md
54bcf97 to
29cb042
Compare
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-doc/references/style/lark-doc-style.md`:
- Line 54: Update the instruction under "编辑已有画板" to pin the docs fetch command
to API v2 by adding the flag `--api-version v2` to the `docs +fetch` invocation
so it reads something like `docs +fetch --api-version v2` before obtaining
`board_token`; locate the line containing "编辑已有画板" and the `docs +fetch` snippet
and modify that snippet accordingly to match the rest of the workflow.
In `@skills/lark-doc/references/style/lark-doc-update-workflow.md`:
- Line 36: Update the step that extracts board_token which currently calls "docs
+fetch" to explicitly use v2 by changing the command to "docs +fetch
--api-version v2" so it matches other occurrences in this workflow; locate the
line under the "编辑已有画板" bullet where board_token is obtained and replace the
invocation to avoid ambiguity.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 535159b0-29ce-4d44-a4a4-e21e4727922d
📒 Files selected for processing (4)
skills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-style.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
✅ Files skipped from review due to trivial changes (1)
- skills/lark-doc/references/style/lark-doc-create-workflow.md
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (2)
skills/lark-doc/references/style/lark-doc-style.md (1)
54-54:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winAlign
docs +fetchwith v2 usage in this section.This line omits
--api-version v2, while the same workflow below (Line 79) requires it.Proposed fix
-- **编辑已有画板**:先 `docs +fetch` 获取 `board_token`,再启动 SubAgent 读取 [`lark-whiteboard`](../../../lark-whiteboard/SKILL.md) skill 写入内容 +- **编辑已有画板**:先 `docs +fetch --api-version v2` 获取 `board_token`,再启动 SubAgent 读取 [`lark-whiteboard`](../../../lark-whiteboard/SKILL.md) skill 写入内容🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/style/lark-doc-style.md` at line 54, Update the "编辑已有画板" instruction so the `docs +fetch` command includes the v2 flag; change the command text `docs +fetch` to `docs +fetch --api-version v2` (same style used later), ensuring references to obtaining `board_token` and the subsequent SubAgent/`lark-whiteboard` workflow remain identical.skills/lark-doc/references/style/lark-doc-update-workflow.md (1)
36-36:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winPin
docs +fetchto v2 before extractingboard_token.Use
docs +fetch --api-version v2here to keep token extraction behavior consistent with the rest of the workflow.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/style/lark-doc-update-workflow.md` at line 36, The step that extracts board_token from the "docs +fetch" result should pin the fetch to v2 to ensure consistent token shape; update the instruction under the "编辑已有画板" step so the command reads "docs +fetch --api-version v2" (the extraction of board_token and subsequent SubAgent launch using the lark-whiteboard skill should reference the v2 fetch output).
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 104: The callout title contains malformed bold markup "⚠️ ** 不支持的装饰特性**"
(note the space after the opening **) which breaks MD037; remove the inner
leading space so the title uses proper bolding (change to "⚠️ **不支持的装饰特性**") in
the content where the callout title appears to fix the markdown lint and
rendering.
---
Duplicate comments:
In `@skills/lark-doc/references/style/lark-doc-style.md`:
- Line 54: Update the "编辑已有画板" instruction so the `docs +fetch` command includes
the v2 flag; change the command text `docs +fetch` to `docs +fetch --api-version
v2` (same style used later), ensuring references to obtaining `board_token` and
the subsequent SubAgent/`lark-whiteboard` workflow remain identical.
In `@skills/lark-doc/references/style/lark-doc-update-workflow.md`:
- Line 36: The step that extracts board_token from the "docs +fetch" result
should pin the fetch to v2 to ensure consistent token shape; update the
instruction under the "编辑已有画板" step so the command reads "docs +fetch
--api-version v2" (the extraction of board_token and subsequent SubAgent launch
using the lark-whiteboard skill should reference the v2 fetch output).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7c372c9e-243b-476b-8bc1-5e681a3a2255
📒 Files selected for processing (4)
skills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-style.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
Change-Id: I615cdf405840fca6bbaea1f95a37ec655fd6aedf
29cb042 to
1ef4a60
Compare
There was a problem hiding this comment.
♻️ Duplicate comments (1)
skills/lark-doc/references/lark-doc-whiteboard.md (1)
106-106:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix malformed bold emphasis in callout title.
The callout title has a space immediately after the opening
**, which breaks MD037 and can render emphasis inconsistently.Proposed fix
-> ⚠️ ** 不支持的装饰特性** +> ⚠️ **不支持的装饰特性**🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 106, Fix the malformed bold callout title "⚠️ ** 不支持的装饰特性" by removing the space after the opening `**` and adding the matching closing `**` so the title is a proper bold token (e.g., change "⚠️ ** 不支持的装饰特性" to "⚠️ **不支持的装饰特性**"); locate and update the callout title text in lark-doc-whiteboard.md to ensure MD037 is satisfied.
🧹 Nitpick comments (2)
skills/lark-doc/references/style/lark-doc-style.md (1)
27-27: ⚡ Quick winFix inconsistent spacing before forward slash.
The list has inconsistent spacing around forward slashes. Add a space before "/思维导图等" to match the pattern used elsewhere in the list.
Proposed fix
-| 流程图 / 时间线 / 示意图 / 自定义图形 / 架构图 / 数据图 /思维导图等 | 画板图表 | +| 流程图 / 时间线 / 示意图 / 自定义图形 / 架构图 / 数据图 / 思维导图等 | 画板图表 |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/style/lark-doc-style.md` at line 27, The table row string "| 流程图 / 时间线 / 示意图 / 自定义图形 / 架构图 / 数据图 /思维导图等 | 画板图表 |" has inconsistent spacing before the slash preceding 思维导图等; update that segment to "数据图 / 思维导图等" so it matches the other items (i.e., ensure a single space before and after each "/" in the list).skills/lark-doc/references/lark-doc-whiteboard.md (1)
24-25: ⚡ Quick winFix inconsistent spacing after colon.
Line 24 uses "2A:" without a space, while Line 25 uses "2B: " with a space. Keep spacing consistent.
Proposed fix
-| 文档中需要思维导图、时序图、类图、饼图、甘特图 | 步骤 2A:使用 mermaid 插入图表 | -| 文档中需要插入其他图表/自定义图形 | 步骤 2B: 使用 SVG 插入图表 | +| 文档中需要思维导图、时序图、类图、饼图、甘特图 | 步骤 2A: 使用 mermaid 插入图表 | +| 文档中需要插入其他图表/自定义图形 | 步骤 2B: 使用 SVG 插入图表 |🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` around lines 24 - 25, Lines containing "步骤 2A:" and "步骤 2B: " have inconsistent spacing after the colon; standardize by inserting a single space after the colon in both entries so they read "步骤 2A: 使用 mermaid 插入图表" and "步骤 2B: 使用 SVG 插入图表", updating the strings "步骤 2A:" and "步骤 2B: " accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 106: Fix the malformed bold callout title "⚠️ ** 不支持的装饰特性" by removing
the space after the opening `**` and adding the matching closing `**` so the
title is a proper bold token (e.g., change "⚠️ ** 不支持的装饰特性" to "⚠️
**不支持的装饰特性**"); locate and update the callout title text in
lark-doc-whiteboard.md to ensure MD037 is satisfied.
---
Nitpick comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Around line 24-25: Lines containing "步骤 2A:" and "步骤 2B: " have inconsistent
spacing after the colon; standardize by inserting a single space after the colon
in both entries so they read "步骤 2A: 使用 mermaid 插入图表" and "步骤 2B: 使用 SVG 插入图表",
updating the strings "步骤 2A:" and "步骤 2B: " accordingly.
In `@skills/lark-doc/references/style/lark-doc-style.md`:
- Line 27: The table row string "| 流程图 / 时间线 / 示意图 / 自定义图形 / 架构图 / 数据图 /思维导图等 |
画板图表 |" has inconsistent spacing before the slash preceding 思维导图等; update that
segment to "数据图 / 思维导图等" so it matches the other items (i.e., ensure a single
space before and after each "/" in the list).
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 7c755208-f8bc-47f0-86f3-e82de2450574
📒 Files selected for processing (4)
skills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-style.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
There was a problem hiding this comment.
♻️ Duplicate comments (1)
skills/lark-doc/references/lark-doc-whiteboard.md (1)
106-106:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix malformed bold emphasis in the callout title.
Line 106 has a space immediately after
**, which breaks emphasis parsing and triggers MD037.Proposed fix
-> ⚠️ ** 不支持的装饰特性** +> ⚠️ **不支持的装饰特性**🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 106, The bold callout title text '⚠️ ** 不支持的装饰特性**' is malformed due to a space after the opening `**`; remove that space so the emphasis parses correctly (change to '⚠️ **不支持的装饰特性**') to resolve MD037 and restore proper bold rendering.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Duplicate comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 106: The bold callout title text '⚠️ ** 不支持的装饰特性**' is malformed due to a
space after the opening `**`; remove that space so the emphasis parses correctly
(change to '⚠️ **不支持的装饰特性**') to resolve MD037 and restore proper bold
rendering.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 86c53d40-3d30-4dd3-8728-40639dea0be2
📒 Files selected for processing (4)
skills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-style.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
✅ Files skipped from review due to trivial changes (1)
- skills/lark-doc/references/style/lark-doc-style.md
There was a problem hiding this comment.
Actionable comments posted: 3
♻️ Duplicate comments (1)
skills/lark-doc/references/lark-doc-whiteboard.md (1)
106-106:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winFix spaces inside emphasis markers (MD037).
The callout title has a space immediately after the opening
**, which violates MD037 and can cause inconsistent rendering.📝 Proposed fix
-> ⚠️ ** 不支持的装饰特性** +> ⚠️ **不支持的装饰特性**🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 106, The callout title string "⚠️ ** 不支持的装饰特性**" contains a space immediately after the opening emphasis marker which triggers MD037; remove the extra space so the title reads "⚠️ **不支持的装饰特性**" (no space after `**`) to fix the emphasis marker spacing and satisfy the linter.
🧹 Nitpick comments (2)
skills/lark-doc/references/lark-doc-whiteboard.md (2)
138-138: ⚡ Quick winUpdate validation rule to use new routing terminology.
Line 138 uses "复杂路径" which refers to the old simple/complex dichotomy being replaced in this PR. Update to match the new three-way routing: "已有画板更新(步骤 3B)只有空白画板而无内容视为任务未完成" or similar phrasing that references the actual routing steps.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` at line 138, Update the validation text on line containing "不保留空白占位画板;复杂路径只有空白画板而无内容视为任务未完成" to use the new routing terminology: replace the "复杂路径" phrase with the three-way routing step reference, e.g. "已有画板更新(步骤 3B)只有空白画板而无内容视为任务未完成", so the rule mentions the specific routing step (步骤 3B) instead of the deprecated "复杂路径".
82-84: 💤 Low valueClarify "操作边界约束:" placement relative to the callout.
Line 84 "操作边界约束:" appears immediately after the
[!IMPORTANT]callout but lacks the>prefix, suggesting it's outside the callout block. If this heading should be part of the callout, add the>prefix. If it should be a separate section header after the callout, add a blank line before it for clarity.📝 Proposed fix (if it should be outside the callout)
> [!IMPORTANT] > 布局, 配色, 信息密度, 装饰物——**全部由你判断**, 打破单调的 `<rect>` 牢笼, 严禁通篇用矩形和文字应付用户 + 操作边界约束:🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@skills/lark-doc/references/lark-doc-whiteboard.md` around lines 82 - 84, The line "操作边界约束:" is ambiguous relative to the `[!IMPORTANT]` callout; decide whether it belongs inside the callout or is a new section and fix accordingly: if it should be part of the callout, prefix that line with ">" so it remains inside the `[!IMPORTANT]` block; if it should be a separate header, insert a blank line between the end of the callout and "操作边界约束:" to clearly separate sections. Ensure you update the surrounding lines near the `[!IMPORTANT]` marker and the "操作边界约束:" text.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Around line 56-62: Update the "SVG Sub Agent minimal context" bullet list in
lark-doc-whiteboard.md to include the missing requirement that the SubAgent must
follow the SVG design workflow: add a new bullet after the existing
insertion-position/doc-token bullets that reads "要求遵循本文档「画板 SVG 设计指南」章节的 SVG 设计
Workflow" so the SubAgent context matches the contracts referenced by
lark-doc-create-workflow.md and lark-doc-update-workflow.md; ensure this new
bullet appears alongside the existing items about doc token/insert position,
chart audience/goal, lark-doc-xml reading, and self-contained SVG requirements.
- Line 34: 将第 34 行中那句包含“且较为复杂的图表”的限定性描述移除,使该句仅保留“建议优先使用 SVG
插入图表,除非其属于思维导图、时序图、类图、饼图、甘特图这类可以直接使用 mermaid
语法描述”,从而让路由规则仅基于图表类型(参照表格中思维导图/时序图/类图/饼图/甘特图的条目)而非“复杂度”判断;请在
lark-doc-whiteboard.md 中定位包含“且较为复杂的图表”的句子并删除该短语以完成修正。
- Around line 7-10: The terminology in the responsibilities table for `lark-doc`
and `lark-whiteboard` is inconsistent with the PR text; update the table entries
for `lark-doc` ("判断简单/复杂", "插入简单 SVG 画板或复杂空白画板", "简单图不需要读取") to the three-way
routing used elsewhere by replacing them with "判断 Mermaid/SVG/已有画板路径", "插入
Mermaid 块、调度 SVG SubAgent、或调度已有画板更新 SubAgent", and "Mermaid 和 SVG 路径不需要读取"
respectively, ensuring `lark-whiteboard` notes remain that only complex or
existing-board updates read the whiteboard.
---
Duplicate comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 106: The callout title string "⚠️ ** 不支持的装饰特性**" contains a space
immediately after the opening emphasis marker which triggers MD037; remove the
extra space so the title reads "⚠️ **不支持的装饰特性**" (no space after `**`) to fix
the emphasis marker spacing and satisfy the linter.
---
Nitpick comments:
In `@skills/lark-doc/references/lark-doc-whiteboard.md`:
- Line 138: Update the validation text on line containing
"不保留空白占位画板;复杂路径只有空白画板而无内容视为任务未完成" to use the new routing terminology: replace
the "复杂路径" phrase with the three-way routing step reference, e.g. "已有画板更新(步骤
3B)只有空白画板而无内容视为任务未完成", so the rule mentions the specific routing step (步骤 3B)
instead of the deprecated "复杂路径".
- Around line 82-84: The line "操作边界约束:" is ambiguous relative to the
`[!IMPORTANT]` callout; decide whether it belongs inside the callout or is a new
section and fix accordingly: if it should be part of the callout, prefix that
line with ">" so it remains inside the `[!IMPORTANT]` block; if it should be a
separate header, insert a blank line between the end of the callout and
"操作边界约束:" to clearly separate sections. Ensure you update the surrounding lines
near the `[!IMPORTANT]` marker and the "操作边界约束:" text.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: bfa38a82-7d1a-4f00-bb18-305c021f59a4
📒 Files selected for processing (4)
skills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-style.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
✅ Files skipped from review due to trivial changes (1)
- skills/lark-doc/references/style/lark-doc-style.md
Change-Id: I0a8ee556f33f0ba65812a3d73fc9c4a5266abbcd
* feat: better whiteboard svg/mermaid instructions Change-Id: I615cdf405840fca6bbaea1f95a37ec655fd6aedf * fix: PR issue Change-Id: I0a8ee556f33f0ba65812a3d73fc9c4a5266abbcd
Summary
Refactor the whiteboard chart insertion flow, replacing the original "simple/complex" dichotomy with a
"Mermaid/SVG/existing board edit" tripartite approach, simplifying new chart creation and enhancing SVG design
guidelines.
Changes
• Refactor lark-doc-whiteboard.md:
• Changed chart type decision from "simple/complex" to type-based routing: mind maps/sequence diagrams/class
diagrams/pie charts/Gantt charts use Mermaid, other new charts use SVG
• Added detailed SVG design guidelines (design workflow, supported SVG element list, unsupported feature warnings)
• Removed blank board creation step; new charts are inserted directly via Mermaid or SVG
• Update lark-doc-create-workflow.md and lark-doc-update-workflow.md:
• Whiteboard path description changed from "simple/complex" to "Mermaid/SVG"
• Mermaid charts inserted directly by main Agent, no SubAgent needed
• SVG SubAgent must carry SVG design workflow guidelines
• Update lark-doc-style.md:
• Element selection guide and whiteboard intent recognition updated accordingly
• Removed standalone "whiteboard syntax and insertion" section, unified reference to lark-doc-whiteboard.md
Test Plan
Related Issues
• None
Summary by CodeRabbit