Skip to content

docs: improve lark-doc skill guidance#1283

Open
fangshuyu-768 wants to merge 1 commit into
mainfrom
codex/optimize-lark-doc-skill
Open

docs: improve lark-doc skill guidance#1283
fangshuyu-768 wants to merge 1 commit into
mainfrom
codex/optimize-lark-doc-skill

Conversation

@fangshuyu-768
Copy link
Copy Markdown
Collaborator

@fangshuyu-768 fangshuyu-768 commented Jun 5, 2026

Summary

  • shorten the lark-doc skill description while preserving the necessary doubao /docx|/wiki routing signals, and add explicit out-of-scope boundaries for comments and sheet/base data operations
  • add a default identity note for document operations so user-scoped access is clearer before readers enter the detailed workflow sections
  • add a scoped CRITICAL v2 reminder for docs +create, docs +fetch, and docs +update, plus a dedicated out-of-scope section for routing document comments, spreadsheet/base data work, whiteboard editing, and generic Drive file management to the right skills

Context

This updates the lark-doc business-domain skill based on the referenced review points, focusing on routing clarity, identity guidance, and keeping the skill concise enough for faster loading.

Testing

  • git diff --check
  • rough token count: 1910

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

Review Change Stack

📝 Walkthrough

Walkthrough

Updated the lark-doc skill documentation: narrowed scope for Feishu Docx/Wiki read/edit, added identity/auth requirements, made v2 API usage mandatory for docs commands, and enumerated out-of-scope responsibilities delegated to other skills.

Changes

lark-doc Skill Scope and Responsibilities

Layer / File(s) Summary
Scope redefinition and identity instructions
skills/lark-doc/SKILL.md
Simplified the top-level skill description to focus on Feishu document read/edit and token-based routing for embedded resources. Added an Identity instruction specifying --as user default and requiring lark-cli auth login before first use. Updated v2 API callout to CRITICAL, requiring --api-version v2 on docs +create, docs +fetch, and docs +update.
Out-of-scope responsibilities enumeration
skills/lark-doc/SKILL.md
Added a "不在本 Skill 范围" section enumerating delegated responsibilities: comments/drive via lark-drive, sheets/Base via lark-sheets/lark-base, whiteboard drawing/complex editing via lark-whiteboard, and drive upload/download/permission management via lark-drive.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • larksuite/cli#1180: Related updates requiring --api-version v2 when extracting/using embedded resource tokens for whiteboard-related skills.
  • larksuite/cli#890: Documentation refinements to skills/lark-doc/SKILL.md tightening scope and v2 guidance.
  • larksuite/cli#1082: Overlapping changes adjusting agent routing and token/path-based routing guidance in skills/lark-doc/SKILL.md.

Suggested reviewers

  • wittam-01

Poem

🐰 I hop through docs with careful cheer,
Scope trimmed and tokens made clear.
Identity set, v2 now sings,
Responsibilities sent to other wings.
A tidy skill — the rabbit hops and grins.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description provides a clear summary, context, and testing approach, but omits the 'Changes' and 'Test Plan' sections required by the template. Add a 'Changes' section listing the main modifications and expand 'Test Plan' with explicit test results (e.g., which tests passed, manual verification results).
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: improve lark-doc skill guidance' is clear and directly related to the main change, which is documentation improvement for the lark-doc 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.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/optimize-lark-doc-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 domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jun 5, 2026
@fangshuyu-768 fangshuyu-768 force-pushed the codex/optimize-lark-doc-skill branch from 8553932 to 1fb96fb Compare June 5, 2026 04:35
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Jun 5, 2026

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#codex/optimize-lark-doc-skill -y -g

@fangshuyu-768 fangshuyu-768 force-pushed the codex/optimize-lark-doc-skill branch from 1fb96fb to 99229a1 Compare June 5, 2026 04:39
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 5, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.17%. Comparing base (a4a4bd6) to head (99229a1).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1283      +/-   ##
==========================================
- Coverage   70.18%   70.17%   -0.01%     
==========================================
  Files         671      671              
  Lines       65240    65329      +89     
==========================================
+ Hits        45786    45845      +59     
- Misses      15783    15795      +12     
- Partials     3671     3689      +18     

☔ 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.

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.

1 participant