Skip to content

docs(skills): sync lark whiteboard skill - #2215

Merged
zkh-bytedance merged 2 commits into
larksuite:mainfrom
ZKHelloworld:sync-lark-whiteboard-20260806
Aug 6, 2026
Merged

docs(skills): sync lark whiteboard skill#2215
zkh-bytedance merged 2 commits into
larksuite:mainfrom
ZKHelloworld:sync-lark-whiteboard-20260806

Conversation

@ZKHelloworld

@ZKHelloworld ZKHelloworld commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Sync generated lark-whiteboard skill docs from whiteboard-docx-block dev-x
  • Add generated mention scene guidance present in the dev-x skill dist
  • Split combined --input_format examples into concrete command values
  • Route existing-board SVG edits through the svg-edit confirmation workflow

Verification

  • lark-cli whiteboard +update --help
  • pnpm --filter @byted-ratio/whiteboard-skill run build
  • diff -qr packages/whiteboard-skill/dist skills/lark-whiteboard
  • rg -n -- "--input_format [a-z]+/[a-z]+|mermaid/plantuml|mermaid/plantuml/svg|PlantUML/SVG|Mermaid/PlantUML/SVG|{{CLI}}|DEBUG=1 node|./packages/whiteboard-cli/bin" packages/whiteboard-skill/dist skills/lark-whiteboard (no matches)

Summary by CodeRabbit

  • 新功能

    • 支持提取 Mermaid 和 PlantUML 源码。
    • 新增白板用户提及说明及标准操作流程。
    • 支持源码重构、属性调整、增量追加和结构重绘等编辑路径。
    • 优化包含图片或用户提及内容的白板处理方式。
  • 文档

    • 完善预览、SVG/raw 导出及导出文件后续编辑说明。
    • 明确覆盖写入与增量追加的区别。
    • 增强破坏性编辑前的确认提示与操作限制说明。
    • 补充 SVG 输出内容及能力边界说明。

@github-actions github-actions Bot added the size/L Large or sensitive change across domains or core paths label Aug 6, 2026
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 24cfa351-eb57-46c8-92ef-965be362499f

📥 Commits

Reviewing files that changed from the base of the PR and between 164d3cc and a446f1b.

📒 Files selected for processing (9)
  • skills/lark-whiteboard/SKILL.md
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/references/lark-whiteboard-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg-edit.md
  • skills/lark-whiteboard/routes/svg.md
  • skills/lark-whiteboard/scenes/mention.md
🚧 Files skipped from review as they are similar to previous changes (9)
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg.md
  • skills/lark-whiteboard/routes/svg-edit.md
  • skills/lark-whiteboard/scenes/mention.md
  • skills/lark-whiteboard/references/lark-whiteboard-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/SKILL.md

📝 Walkthrough

Walkthrough

The whiteboard guidance separates read and write routing, adds explicit editing paths and confirmation rules, clarifies export and overwrite behavior, updates workflow references, and documents mentionUser input requirements.

Changes

Whiteboard workflow guidance

Layer / File(s) Summary
Request and edit routing
skills/lark-whiteboard/SKILL.md, skills/lark-whiteboard/references/lark-whiteboard-workflow.md
The decision flow separates read and write operations. Editing checks source editability, selects an editing path, and routes rendering by artifact type, chart type, and identity.
Export and write contracts
skills/lark-whiteboard/references/lark-whiteboard-export.md, skills/lark-whiteboard/references/lark-whiteboard-update.md, skills/lark-whiteboard/routes/svg-edit.md, skills/lark-whiteboard/routes/svg.md
The guides clarify output formats, overwrite and append behavior, confirmation handling, and SVG artifact warnings.
Route reference wiring
skills/lark-whiteboard/routes/dsl.md, skills/lark-whiteboard/routes/mermaid.md, skills/lark-whiteboard/references/lark-whiteboard-update.md
Route documentation links to the dedicated workflow guide. The DSL index separates mention and image guidance.
User mention scene contract
skills/lark-whiteboard/scenes/mention.md
The guide defines mentionUser IDs, placeholder content, run separation, DSL structure, and invalid examples.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the documentation synchronization across the lark-whiteboard skill.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

Tools execution failed with the following error:

Failed to run tools: 14 UNAVAILABLE: read ECONNRESET


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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-whiteboard/references/lark-whiteboard-node-create.md`:
- Line 33: Pin the `@larksuite/whiteboard-cli` version exactly, replacing the
caret range in
skills/lark-whiteboard/references/lark-whiteboard-node-create.md:33 and applying
the same approved exact version or repository-pinned executable to all CLI
invocations in skills/lark-whiteboard/references/lark-whiteboard-update.md:76,
skills/lark-whiteboard/routes/dsl.md:28-33, and
skills/lark-whiteboard/routes/mermaid.md:16-19.

In `@skills/lark-whiteboard/references/lark-whiteboard-node-update.md`:
- Around line 34-36: The update documentation currently references the wrong
response wrapper paths. In the +node-update guidance, change the documented
envelope extraction path to data.result.nodes at the references on lines 36, 43,
and 88, while keeping raw input normalization as top-level nodes; ensure the
warning only discourages actively constructing an envelope and does not claim
data.nodes support.
🪄 Autofix

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 Plus

Run ID: 6eb35fda-c9cf-4ddc-b2ec-b585ca62d350

📥 Commits

Reviewing files that changed from the base of the PR and between 164d3cc and 6a3de6e.

📒 Files selected for processing (12)
  • skills/lark-whiteboard/SKILL.md
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/references/lark-whiteboard-node-create.md
  • skills/lark-whiteboard/references/lark-whiteboard-node-delete.md
  • skills/lark-whiteboard/references/lark-whiteboard-node-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg-edit.md
  • skills/lark-whiteboard/routes/svg.md
  • skills/lark-whiteboard/scenes/mention.md

Comment thread skills/lark-whiteboard/references/lark-whiteboard-node-create.md Outdated
Comment thread skills/lark-whiteboard/references/lark-whiteboard-node-update.md Outdated
Co-authored-by: TRAE CLI <traecli@bytedance.com>
@ZKHelloworld
ZKHelloworld force-pushed the sync-lark-whiteboard-20260806 branch from 6a3de6e to de89640 Compare August 6, 2026 12:00
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@github-actions github-actions Bot added size/M Single-domain feat or fix with limited business impact and removed size/L Large or sensitive change across domains or core paths labels Aug 6, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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-whiteboard/SKILL.md`:
- Line 39: Separate the invalid combined --input_format values into individual
mermaid, plantuml, and svg alternatives in
skills/lark-whiteboard/SKILL.md:39-39, and individual mermaid and plantuml
alternatives in
skills/lark-whiteboard/references/lark-whiteboard-workflow.md:34-34; keep each
alternative as a separate command value.
- Line 39: Update the Mermaid/PlantUML/SVG routing table in SKILL.md to
distinguish new SVG creation from edits to an existing board. For existing-board
SVG edits, require the confirmation workflow defined in routes/svg-edit.md
before invoking +update; keep the direct +update path for user-supplied
Mermaid/PlantUML code and new SVG creation.
🪄 Autofix

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 Plus

Run ID: a6dfc65b-595e-4a0e-8e8d-587cfb7eb464

📥 Commits

Reviewing files that changed from the base of the PR and between 164d3cc and de89640.

📒 Files selected for processing (9)
  • skills/lark-whiteboard/SKILL.md
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/references/lark-whiteboard-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg-edit.md
  • skills/lark-whiteboard/routes/svg.md
  • skills/lark-whiteboard/scenes/mention.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/lark-whiteboard/routes/svg.md

Comment thread skills/lark-whiteboard/SKILL.md Outdated
@github-actions

github-actions Bot commented Aug 6, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@a446f1b08534ff2bd310ce3fbe1d23e006280768

🧩 Skill update

npx skills add ZKHelloworld/lark-cli#sync-lark-whiteboard-20260806 -y -g

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
skills/lark-whiteboard/references/lark-whiteboard-workflow.md (1)

50-60: 🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Make the current artifact type an explicit routing condition.

Line 50 claims that routing uses the current artifact type, chart type, and identity. Lines 54-60 define only chart type and identity, with a separate mention/image rule. They do not define how an existing Mermaid, PlantUML, SVG, or DSL artifact affects routing. This can select a renderer that conflicts with the final write format in Lines 85-90. Add an artifact-type column or define its precedence over chart type and identity.

🤖 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-whiteboard/references/lark-whiteboard-workflow.md` around lines
50 - 60, Update the routing table and matching rules around the current artifact
routing section to explicitly include the current artifact type (such as
Mermaid, PlantUML, SVG, or DSL) as a routing condition. Define its precedence
relative to the existing mention/image, chart-type, and identity rules, ensuring
the selected route remains compatible with the final write format described
later in the workflow.
🧹 Nitpick comments (1)
skills/lark-whiteboard/references/lark-whiteboard-workflow.md (1)

34-35: 🗄️ Data Integrity & Integration | 🔵 Trivial | ⚡ Quick win

Document source’s Mermaid/PlantUML selection rule.

+export --output-type source documents returning source code, but the workflow routes this output to two different +update --input_format values. Add the source-type marker or detection rule so agents send valid source to the matching parser.

🤖 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-whiteboard/references/lark-whiteboard-workflow.md` around lines
34 - 35, 在工作流中补充 Mermaid 与 PlantUML 源码的识别规则或 source 类型标记,明确 `+export
--output-type source` 的返回类型如何确定;确保代理依据该规则将源码分别传给匹配的 `+update --input_format
mermaid` 或 `plantuml`,避免解析器选择错误。
🤖 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-whiteboard/references/lark-whiteboard-workflow.md`:
- Around line 34-35: The source-backed Mermaid and PlantUML rows in the workflow
documentation must explicitly handle user-requested append operations. Update
the Mermaid/PlantUML edit guidance to either allow the documented user-specified
append exception, matching the SVG guidance, or require confirmation that append
re-renders the complete source instead of unconditionally using overwrite.

---

Outside diff comments:
In `@skills/lark-whiteboard/references/lark-whiteboard-workflow.md`:
- Around line 50-60: Update the routing table and matching rules around the
current artifact routing section to explicitly include the current artifact type
(such as Mermaid, PlantUML, SVG, or DSL) as a routing condition. Define its
precedence relative to the existing mention/image, chart-type, and identity
rules, ensuring the selected route remains compatible with the final write
format described later in the workflow.

---

Nitpick comments:
In `@skills/lark-whiteboard/references/lark-whiteboard-workflow.md`:
- Around line 34-35: 在工作流中补充 Mermaid 与 PlantUML 源码的识别规则或 source 类型标记,明确 `+export
--output-type source` 的返回类型如何确定;确保代理依据该规则将源码分别传给匹配的 `+update --input_format
mermaid` 或 `plantuml`,避免解析器选择错误。
🪄 Autofix

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 Plus

Run ID: f1155a8b-0f47-4db7-a918-20555bf18d7b

📥 Commits

Reviewing files that changed from the base of the PR and between de89640 and 7bfad69.

📒 Files selected for processing (2)
  • skills/lark-whiteboard/SKILL.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md

Comment thread skills/lark-whiteboard/references/lark-whiteboard-workflow.md Outdated
@ZKHelloworld
ZKHelloworld force-pushed the sync-lark-whiteboard-20260806 branch from 7bfad69 to 3cc6a2c Compare August 6, 2026 12:35
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 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-whiteboard/SKILL.md`:
- Line 39: Use one confirmation gate for all existing-board source edits: update
skills/lark-whiteboard/SKILL.md lines 39-39 to route existing-board
Mermaid/PlantUML changes through the edit workflow before +update, and update
skills/lark-whiteboard/references/lark-whiteboard-workflow.md lines 86-86 to
apply the same confirmation rule to existing-board Mermaid/PlantUML writes or
restrict direct writes to new boards.
🪄 Autofix

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 Plus

Run ID: ebcff70b-4c9f-4f66-8659-0caee427dfe3

📥 Commits

Reviewing files that changed from the base of the PR and between 164d3cc and 3cc6a2c.

📒 Files selected for processing (9)
  • skills/lark-whiteboard/SKILL.md
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/references/lark-whiteboard-update.md
  • skills/lark-whiteboard/references/lark-whiteboard-workflow.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg-edit.md
  • skills/lark-whiteboard/routes/svg.md
  • skills/lark-whiteboard/scenes/mention.md
🚧 Files skipped from review as they are similar to previous changes (4)
  • skills/lark-whiteboard/references/lark-whiteboard-export.md
  • skills/lark-whiteboard/routes/dsl.md
  • skills/lark-whiteboard/routes/mermaid.md
  • skills/lark-whiteboard/routes/svg.md

Comment thread skills/lark-whiteboard/SKILL.md Outdated
@zkh-bytedance
zkh-bytedance self-requested a review August 6, 2026 12:54
zkh-bytedance
zkh-bytedance previously approved these changes Aug 6, 2026
Co-authored-by: TRAE CLI <traecli@bytedance.com>
@coderabbitai

coderabbitai Bot commented Aug 6, 2026

Copy link
Copy Markdown

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@zkh-bytedance
zkh-bytedance merged commit 27ab8fb into larksuite:main Aug 6, 2026
21 checks passed
@liangshuo-1 liangshuo-1 mentioned this pull request Aug 7, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants