Skip to content

docs(lark-slides): tighten SKILL.md routing and trim always-loaded content - #1169

Merged
fangshuyu-768 merged 1 commit into
mainfrom
optimize/lark-slides-skill
Jun 8, 2026
Merged

docs(lark-slides): tighten SKILL.md routing and trim always-loaded content#1169
fangshuyu-768 merged 1 commit into
mainfrom
optimize/lark-slides-skill

Conversation

@ViperCai

@ViperCai ViperCai commented May 29, 2026

Copy link
Copy Markdown
Collaborator

Background

Source: the CCM skill-quality audit doc (wiki), which raised 10 issues for lark-slides. After review this PR lands only the high-value, low-risk routing/boundary fixes and deliberately pushes back on the more aggressive structural suggestions. The net change is intentionally small: SKILL.md only (15 insertions / 15 deletions).

Note: this branch was rebased onto the latest main (which had added in-slide <whiteboard> support, #1029). History was force-pushed; an earlier draft of this description described changes that were later reverted — the table below reflects what the branch actually does now.

Changes (all in SKILL.md)

Audit item Action
description contains impl detail / missing NOT Drop 接口通过 XML 协议通信; append a 不负责:... out-of-scope clause so "make a deck" / "draw a diagram" no longer mis-route to lark-doc / lark-whiteboard
No reverse-boundary section Replace the 权限速查 table with a ## 不在本 skill 范围 routing table (doc / whiteboard / drive / sheets / base)
Whiteboard boundary vs in-slide <whiteboard> (surfaced by the rebase) Reconcile the new boundary with main's #1029: lark-whiteboard owns only standalone whiteboard objects in cloud docs; flow/architecture diagrams drawn inside a slide stay in this skill via the <whiteboard> element. Clarified in both the description and the out-of-scope note
lark-shared duplication Reword the preflight line to defer auth / permissions / global params to lark-shared as the single source of truth
Native-API guidance placement Move the high-frequency-resource line out of the code comment into prose; reword the schema reminder as a callout; move the "schema is source of truth" note next to 核心规则

Deliberately not adopted / reverted

These were considered and intentionally left as-is (see the revert commits in history):

  • Move "Design Ideas" out to a reference — kept inline. It's load-bearing visual guidance the agent reliably acts on only when it's in the always-loaded body; relocating it risks lower adherence for marginal token savings.
  • Relocate / delete the wiki-token section — kept. The Wiki 链接特殊处理 section stays; native-API callers still need that manual step.
  • "schema note duplicates lark-shared" — kept. It's a slides native-API usage guardrail ("don't guess fields"), not a true duplication.
  • Bulk-rename 13 reference files to a lark-slides- prefix — not done. Purely cosmetic, touches every link with breakage risk for marginal benefit. (Audit premise was also partly wrong: the "loose" files are reachable transitively via the CRITICAL xml-schema-quick-ref.md.)

Verification

  • All cross-skill relative links (doc / whiteboard / drive / sheets / base / shared) confirmed to exist; no dangling references.
  • Confirmed no contradiction remains between the Quick Reference <whiteboard> row and the out-of-scope table after the rebase.

@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown

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
📝 Walkthrough

Walkthrough

Updated skills/lark-slides/SKILL.md to refine the skill description, point precondition/authentication governance to ../lark-shared/SKILL.md, add native API guidance for cases without Shortcut coverage, and replace the permissions table with an out-of-scope routing table.

Changes

Lark Slides Documentation Refinement

Layer / File(s) Summary
Skill metadata and precondition rules
skills/lark-slides/SKILL.md
Reworded the front-matter description to remove "XML 协议" wording while preserving routing rules; updated the "开始前 MUST" note to reference ../lark-shared/SKILL.md for auth, permissions, and global params.
Native API guidance (no Shortcut)
skills/lark-slides/SKILL.md
Added "没有 Shortcut 覆盖时使用原生 API" with example CLI commands, listed native methods (xml_presentations.get, xml_presentation.slide.create/delete/get/replace), and mandated running schema first to validate --data/--params.
Out-of-scope routing table
skills/lark-slides/SKILL.md
Replaced the prior permissions cheat-sheet with a routing table that directs out-of-scope tasks (docx/wiki editing, whiteboard drawing, drive operations, embedded tables/multi-dimensional data) to lark-doc, lark-whiteboard, lark-drive, and lark-sheets/lark-base.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • larksuite/cli#1082: Earlier docs change for lark-slides routing by URL path/token that this PR extends.
  • larksuite/cli#389: Initial lark-slides skill documentation and shortcut setup that this PR refines.

Suggested labels

domain/ccm

Suggested reviewers

  • fangshuyu-768
  • kongenpei

Poem

🐰 I hopped through docs with careful cheer,
Swapped a phrase and pointed auth clear,
When Shortcut fades, use native calls,
Out-of-scope finds its proper halls,
Slides now guide the devs near and dear.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: tightening SKILL.md routing and trimming always-loaded content from lark-slides documentation.
Description check ✅ Passed The description includes Background, Changes, Verification sections with detailed explanations, but lacks explicit Test Plan and Related Issues sections from the template.
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 optimize/lark-slides-skill

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 the size/M Single-domain feat or fix with limited business impact label May 29, 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-slides/references/lark-slides-permissions.md`:
- Line 3: Update the remediation instructions for missing scopes: replace the
user identity command suggestion `auth login --domain slides` with the correct
CLI usage that supplies the missing scopes, e.g. `lark-cli auth login --scope
"<missing scopes>"` (or `auth login --scope "<missing scopes>"` if using local
CLI shorthand) so it matches the missing-scope handling referenced in SKILL.md;
ensure the text around the `user 身份` guidance and the `bot 身份` guidance remains
consistent with this corrected flag usage.
- Line 9: Update the table row for the `slides +replace-slide` shortcut to
include the missing scope `slides:presentation:write_only` alongside
`slides:presentation:update` and `wiki:node:read` so the documented scopes match
the actual shortcut declaration and prevent preflight auth failures; locate the
entry referencing "`slides +replace-slide`" in lark-slides-permissions.md and
append `slides:presentation:write_only` to the listed scopes.
🪄 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: 0c4bbb3e-3aa7-4b0f-8eaf-622633bba3bd

📥 Commits

Reviewing files that changed from the base of the PR and between 0a2c320 and eeaf291.

📒 Files selected for processing (3)
  • skills/lark-slides/SKILL.md
  • skills/lark-slides/references/lark-slides-permissions.md
  • skills/lark-slides/references/visual-planning.md

Comment thread skills/lark-slides/references/lark-slides-permissions.md Outdated
Comment thread skills/lark-slides/references/lark-slides-permissions.md Outdated
@codecov

codecov Bot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.39%. Comparing base (a75420f) to head (4ee05ce).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1169      +/-   ##
==========================================
+ Coverage   70.33%   70.39%   +0.06%     
==========================================
  Files         672      677       +5     
  Lines       65322    65599     +277     
==========================================
+ Hits        45941    46176     +235     
- Misses      15728    15757      +29     
- Partials     3653     3666      +13     

☔ View full report in Codecov by Harness.
📢 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.

@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#optimize/lark-slides-skill -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

🤖 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-slides/SKILL.md`:
- Around line 213-214: The doc uses dot notation
`xml_presentation.slide.create/delete/get/replace` which conflicts with later
CLI-style examples; update the mention to the space-separated CLI-style form
`xml_presentation.slide create/delete/get/replace` (and similarly change
`xml_presentations.get` to `xml_presentations get` where appropriate) so it
matches the `lark-cli slides <resource> <method>` format used elsewhere in the
file and avoids implying a single command path.
🪄 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: 203010bd-bd81-465b-b70a-10ec3d2133a0

📥 Commits

Reviewing files that changed from the base of the PR and between eeaf291 and 2eaa367.

📒 Files selected for processing (1)
  • skills/lark-slides/SKILL.md

Comment thread skills/lark-slides/SKILL.md
@ViperCai
ViperCai force-pushed the optimize/lark-slides-skill branch from a633ada to d36b62c Compare June 5, 2026 08:42
@ViperCai

ViperCai commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator Author

已 rebase 到最新 main(force-push,历史重写)。本次更新:

  • Rebase 到 main(领先 53 commit),无文本冲突。
  • 修复 rebase 暴露的语义冲突:main docs(slides): add whiteboard element documentation and improve slide guidance #1029 新增了 slide 内 <whiteboard> 元素能力,与本分支新加的反向边界(架构图/流程图→lark-whiteboard)矛盾。已澄清 lark-whiteboard 只管云文档里独立画板对象,slide 内嵌图表留本 skill。
  • schema-authority 提示移到核心规则旁。

@ViperCai
ViperCai force-pushed the optimize/lark-slides-skill branch from d36b62c to eaa779e Compare June 5, 2026 08:49
Comment thread skills/lark-slides/SKILL.md Outdated
…iteboard

Land the high-value, low-risk items from the skill-quality audit; SKILL.md only.

- description: drop the '接口通过 XML 协议通信' impl detail; append a 不负责
  out-of-scope clause so 'make a deck' / 'draw a diagram' stop mis-routing.
- replace the 权限速查 scope table with a ## 不在本 skill 范围 routing table
  (doc / whiteboard / drive / sheets / base).
- reconcile the whiteboard boundary with the in-slide <whiteboard> element
  (added on main, #1029): lark-whiteboard owns only standalone whiteboard
  objects in cloud docs; flow/architecture diagrams drawn inside a slide stay
  in this skill via <whiteboard>. Clarified in description and out-of-scope note.
- defer auth / permissions / global params to lark-shared as single source.
- move native-API resource hint into prose; reword schema reminder; move the
  'schema is source of truth' note next to 核心规则.

Deliberately not adopted: moving Design Ideas out of the body, relocating the
wiki-token section, dropping the native-API schema guardrail, and the bulk
lark-slides- reference rename.
@ViperCai
ViperCai force-pushed the optimize/lark-slides-skill branch from eaa779e to 4ee05ce Compare June 5, 2026 09:43
@fangshuyu-768
fangshuyu-768 merged commit add079e into main Jun 8, 2026
21 checks passed
@fangshuyu-768
fangshuyu-768 deleted the optimize/lark-slides-skill branch June 8, 2026 08:37
SunPeiYang996 pushed a commit that referenced this pull request Jun 8, 2026
…iteboard (#1169)

Land the high-value, low-risk items from the skill-quality audit; SKILL.md only.

- description: drop the '接口通过 XML 协议通信' impl detail; append a 不负责
  out-of-scope clause so 'make a deck' / 'draw a diagram' stop mis-routing.
- replace the 权限速查 scope table with a ## 不在本 skill 范围 routing table
  (doc / whiteboard / drive / sheets / base).
- reconcile the whiteboard boundary with the in-slide <whiteboard> element
  (added on main, #1029): lark-whiteboard owns only standalone whiteboard
  objects in cloud docs; flow/architecture diagrams drawn inside a slide stay
  in this skill via <whiteboard>. Clarified in description and out-of-scope note.
- defer auth / permissions / global params to lark-shared as single source.
- move native-API resource hint into prose; reword schema reminder; move the
  'schema is source of truth' note next to 核心规则.

Deliberately not adopted: moving Design Ideas out of the body, relocating the
wiki-token section, dropping the native-API schema guardrail, and the bulk
lark-slides- reference rename.
@coderabbitai coderabbitai Bot mentioned this pull request Jun 10, 2026
2 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.

3 participants