Skip to content

docs: add svg whiteboard support to doc v2 skill#901

Merged
SunPeiYang996 merged 1 commit into
mainfrom
sun/chore
May 15, 2026
Merged

docs: add svg whiteboard support to doc v2 skill#901
SunPeiYang996 merged 1 commit into
mainfrom
sun/chore

Conversation

@SunPeiYang996
Copy link
Copy Markdown
Collaborator

@SunPeiYang996 SunPeiYang996 commented May 15, 2026

Change-Id: Icada6fb894aaf9a00187fa68c132d3ade8223b99

Summary by CodeRabbit

  • Documentation
    • Updated guidance on whiteboard usage, distinguishing between simple SVG diagrams and complex visualizations
    • Refined workflow recommendations for creating and updating documents with visual elements
    • Expanded best practices for planning and implementing diagrams in document creation processes

Review Change Stack

Summary by CodeRabbit

  • Documentation
    • Enhanced whiteboard support for Lark docs with clearer guidance on using SVG whiteboards for simple diagrams and a streamlined process for complex visualizations.
    • Updated workflow documentation to clarify how to incorporate whiteboards when creating and updating documents.
    • Revised style guides emphasizing whiteboard usage for visualizing important information.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 15, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 096ecca1-ded0-4ac6-9571-1826b35bff65

📥 Commits

Reviewing files that changed from the base of the PR and between 1a8a895 and 86a39a4.

📒 Files selected for processing (7)
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-whiteboard.md
  • skills/lark-doc/references/lark-doc-xml.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md
  • skills/lark-doc/references/style/lark-doc-style.md
  • skills/lark-doc/references/style/lark-doc-update-workflow.md
✅ Files skipped from review due to trivial changes (3)
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/style/lark-doc-style.md
🚧 Files skipped from review as they are similar to previous changes (3)
  • skills/lark-doc/references/lark-doc-xml.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md
  • skills/lark-doc/references/style/lark-doc-update-workflow.md

📝 Walkthrough

Walkthrough

This PR updates lark-doc documentation to require planning whiteboards for important content, adds explicit SVG whiteboard support, and defines two paths: simple SVG insertion (self-contained inline SVG via an SVG SubAgent) and complex boards (insert blank board, extract board_token, then populate via lark-whiteboard SubAgent). Changes propagate through creation, update, style, and XML docs.

Changes

Whiteboard workflow and execution pattern

Layer / File(s) Summary
Whiteboard responsibility boundary and decision criteria
skills/lark-doc/references/lark-doc-whiteboard.md
Core redesign establishes simple vs complex board paths (2A/2B/3B), defined roles for lark-doc and lark-whiteboard SubAgents, minimal context requirements, and validation rules for token population and empty board prevention.
XML elements, type attributes, and style insertion rules
skills/lark-doc/references/lark-doc-xml.md, skills/lark-doc/references/style/lark-doc-style.md
XML <whiteboard> element expanded with svg type support; style selection matrix and insertion rules rewritten to route simple diagrams to direct SVG SubAgent insertion and complex diagrams to blank-then-populate flow.
Skill description, quick decisions, and semantic mappings
skills/lark-doc/SKILL.md, skills/lark-doc/references/lark-doc-update.md, skills/lark-doc/references/lark-doc-whiteboard.md
SKILL.md front-matter emphasizes whiteboard visualization and SVG 画板 in v2 workflow; quick-decision bullets added for content planning and SubAgent routing; lark-doc-update.md updated to delegate complex boards via SubAgent; semantic-to-board-type mapping extended with simple custom SVG routing.
Creation workflow planning and board intent identification
skills/lark-doc/references/style/lark-doc-create-workflow.md
Planning constraints require at least one non-text block per h1/h2 section with whiteboard priority for information-heavy sections; board intent identification phase restructured to scan per-section, record block IDs and complexity; execution split into simple SVG and complex board paths.
Update workflow analysis, execution, and agent task specification
skills/lark-doc/references/style/lark-doc-update-workflow.md
First wave expanded with style metrics assessment and whiteboard opportunity detection; second wave diagram handling split into SVG SubAgent (simple direct insertion) and complex-board workflow (blank placeholder + token extraction); agent task requirements explicitly specify content rewrite and diagram subagent inputs.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes


Possibly related PRs

  • larksuite/cli#891: Adds docs +fetch --api-version v2 usage for retrieving board_token before editing, directly related to the board_token extraction/update guidance.
  • larksuite/cli#661: Overlaps on SVG whiteboard handling rules and constraints relevant to simple inline SVG insertion guidance.
  • larksuite/cli#890: Related updates to skills/lark-doc/SKILL.md front-matter and v2 description text.

Suggested reviewers

  • fangshuyu-768
  • syh-cpdsss

Poem

🐰 I nibble notes on every frame,

SVG seeds and blank-board game;
Simple art fits full and neat,
Complex boards we build discrete.
SubAgents hum and tokens sing—docs bloom like spring.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description lacks required sections from the template: a detailed Summary section, a Changes list with bullet points, a Test Plan with verification steps, and a Related Issues section. Fill in the PR description template sections: provide a clear 1-3 sentence summary, list main changes with bullets, describe testing/verification, and specify related issues or link them.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: adding SVG whiteboard support to the doc v2 skill, which is the primary focus across all documentation updates.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch sun/chore

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 and usage tips.

@github-actions github-actions Bot added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels May 15, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 15, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.95%. Comparing base (f03138b) to head (86a39a4).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #901   +/-   ##
=======================================
  Coverage   65.95%   65.95%           
=======================================
  Files         523      523           
  Lines       49590    49590           
=======================================
  Hits        32707    32707           
  Misses      14090    14090           
  Partials     2793     2793           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Change-Id: Icada6fb894aaf9a00187fa68c132d3ade8223b99
@github-actions
Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#sun/chore -y -g

@SunPeiYang996 SunPeiYang996 merged commit 4a45e00 into main May 15, 2026
22 checks passed
@SunPeiYang996 SunPeiYang996 deleted the sun/chore branch May 15, 2026 08:18
@liangshuo-1 liangshuo-1 mentioned this pull request May 15, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/ccm PR touches the ccm domain 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