Skip to content

docs(lark-wiki): tighten SKILL.md per skill review#1275

Open
liujinkun2025 wants to merge 1 commit into
mainfrom
docs/optimize-lark-wiki-skill
Open

docs(lark-wiki): tighten SKILL.md per skill review#1275
liujinkun2025 wants to merge 1 commit into
mainfrom
docs/optimize-lark-wiki-skill

Conversation

@liujinkun2025
Copy link
Copy Markdown
Collaborator

@liujinkun2025 liujinkun2025 commented Jun 5, 2026

Summary

Optimize the lark-wiki skill for clearer routing boundaries, better shortcut discoverability, and less duplicated maintenance-heavy guidance. Documentation only — no code or CLI behavior changes.

  • Add explicit NOT boundaries to the description and a dedicated ## 不在本 skill 范围 section: file upload → lark-drive, content editing → lark-doc / lark-sheets / lark-base, search / comments / permissions → lark-drive.
  • Move the Shortcuts table up (right after 快速决策) so command entry points are discoverable first; keep the member-add flow and target-semantics sections after it.
  • Add an inline reminder under the delete-space guidance that a wiki URL / space name is not a space_id and must be resolved via wiki spaces get_node first.
  • Remove the duplicated permission (scope) table and the redundant schema note so auth / permission guidance stays centralized in lark-shared (the API resource listing is kept).
  • Bump the skill version to 1.0.1.
  • Keep skill-template/domains/wiki.md in sync with the SKILL.md introduction narrative.

Testing

  • node scripts/skill-format-check/index.js skills → passed
  • All markdown links resolve (incl. cross-skill doc / sheets / base / drive references)
  • 快速决策 sections in SKILL.md and domains/wiki.md verified identical

Note

Supersedes #1280 (same target file). This PR additionally keeps the API Resources resource listing and syncs the domain template.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 5, 2026

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

Walkthrough

Refines the lark-wiki skill docs: clarifies routing for doubao.com/wiki tokens, adds BAD/GOOD delete-space workflow, reorganizes member-add steps with ID lookup, requires lark-cli schema wiki.<resource>.<method> for API parameter inspection, and lists out-of-scope operations delegated to other skills.

Changes

Wiki Skill Documentation Refinement

Layer / File(s) Summary
Skill scope and delegated responsibilities
skills/lark-wiki/SKILL.md
Skill description extended to specify routing for doubao.com /wiki/<token> URLs and enumerate delegated non-responsibilities (uploads, content editing). New "不在本 skill 范围" section lists out-of-scope operations (upload/download, document editing, sheets/base operations, search/comment/permission management via lark-drive).
Operational workflows and API guidance
skills/lark-wiki/SKILL.md, skill-template/domains/wiki.md
Added BAD/GOOD example for wiki +delete-space showing correct space_id resolution via wiki spaces get_node. Reorganized "成员添加流程" with explicit lookup steps by member type (user/group/app/department) and updated "API Resources" guidance to require lark-cli schema wiki.<resource>.<method> checks before calling native APIs. Also propagated the delete-space guidance into the wiki template.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

  • larksuite/cli#1082: Overlapping updates to routing behavior for doubao.com /wiki/<token> in wiki skill descriptions.
  • larksuite/cli#417: Related changes to member-add flow and space_id resolution guidance in skills/lark-wiki/SKILL.md.
  • larksuite/cli#1028: Related docs on wiki space_id/token-resolution and boundaries with lark-drive workflows.

Suggested reviewers

  • fangshuyu-768
  • kongenpei

Poem

🐰 I hopped through docs with nimble feet,
Cleared tokens, IDs, and routing neat.
I flagged the bad flags and showed the right way,
Guided member IDs step by step today.
Hooray — the rabbit leaves the wiki tidy and sweet.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically summarizes the main change: documentation updates to SKILL.md based on skill review findings.
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.
Description check ✅ Passed The PR description covers all required sections with clear motivation, comprehensive changes list, testing verification, and related context.

✏️ 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 docs/optimize-lark-wiki-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
Comment thread skills/lark-wiki/SKILL.md Outdated
@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.33%. Comparing base (ac116e7) to head (923dc9f).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1275      +/-   ##
==========================================
+ Coverage   70.18%   70.33%   +0.14%     
==========================================
  Files         671      672       +1     
  Lines       65240    65322      +82     
==========================================
+ Hits        45786    45941     +155     
+ Misses      15783    15728      -55     
+ Partials     3671     3653      -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.

@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@923dc9f88e000b8c908e4c37081106fa4a8862c0

🧩 Skill update

npx skills add larksuite/cli#docs/optimize-lark-wiki-skill -y -g

@liujinkun2025 liujinkun2025 force-pushed the docs/optimize-lark-wiki-skill branch from 5010a3e to 042c09c Compare June 5, 2026 02:51
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

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-wiki/SKILL.md`:
- Around line 79-80: Replace the incorrect Chinese collocation "部门场景" in the two
bullet points with a better phrase such as "部门相关场景" or "涉及部门时"; update both
occurrences in SKILL.md (the two lines that mention calling the contact API and
then `lark-cli wiki +member-add`) so the text reads e.g. "部门相关场景使用
`--member-type=opendepartmentid`:..." and "只有在目标类型和身份都已确认可行后,才调用 `lark-cli wiki
+member-add`。对于部门相关场景,这意味着必须是 `--as user`。" Ensure consistency for both
instances.
🪄 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: 2de39474-2e5c-4408-8509-f291d2d27e5e

📥 Commits

Reviewing files that changed from the base of the PR and between 5010a3e and 042c09c.

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

Comment thread skills/lark-wiki/SKILL.md
@liujinkun2025 liujinkun2025 force-pushed the docs/optimize-lark-wiki-skill branch from 042c09c to c2bb954 Compare June 5, 2026 02:58
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

♻️ Duplicate comments (1)
skills/lark-wiki/SKILL.md (1)

79-80: ⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

建议替换“部门场景”为更自然表达(如“涉及部门时/部门相关场景”)。

这两处搭配不够自然,建议统一替换,避免文档读感割裂。

🤖 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-wiki/SKILL.md` around lines 79 - 80, Replace the wording "部门场景"
with a more natural phrase (e.g., "涉及部门时" or "部门相关场景") in the two occurrences
shown around the examples: the line containing
"`--member-type=opendepartmentid`" (the CLI call that fetches
`open_department_id`) and the line referencing "`lark-cli wiki +member-add`"
(the note about needing `--as user` for department cases); keep the surrounding
CLI examples and meaning unchanged, only update the phrase for consistent,
natural prose.
🤖 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-wiki/SKILL.md`:
- Around line 79-80: Replace the wording "部门场景" with a more natural phrase
(e.g., "涉及部门时" or "部门相关场景") in the two occurrences shown around the examples:
the line containing "`--member-type=opendepartmentid`" (the CLI call that
fetches `open_department_id`) and the line referencing "`lark-cli wiki
+member-add`" (the note about needing `--as user` for department cases); keep
the surrounding CLI examples and meaning unchanged, only update the phrase for
consistent, natural prose.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 2af759cc-3273-42aa-bf08-ca07720603ec

📥 Commits

Reviewing files that changed from the base of the PR and between 042c09c and c2bb954.

📒 Files selected for processing (2)
  • skill-template/domains/wiki.md
  • skills/lark-wiki/SKILL.md
✅ Files skipped from review due to trivial changes (1)
  • skill-template/domains/wiki.md

@liujinkun2025 liujinkun2025 force-pushed the docs/optimize-lark-wiki-skill branch 3 times, most recently from 76c9f14 to 2e4c765 Compare June 5, 2026 07:36
- Add explicit NOT boundaries to the description and a dedicated
  "不在本 skill 范围" section: file upload -> lark-drive, content
  editing -> lark-doc / lark-sheets / lark-base.
- Move the Shortcuts table up, right after 快速决策, so command entry
  points are discoverable first; keep the member-add flow and
  target-semantics sections after it.
- Add an inline reminder under the delete-space guidance that a wiki
  URL / name is not a space_id and must be resolved via
  `wiki spaces get_node` first.
- Remove the duplicated permission (scope) table and the redundant
  schema note so auth/permission guidance stays centralized in
  lark-shared.
- Bump the skill version to 1.0.1.
- Keep skill-template/domains/wiki.md in sync with the SKILL.md
  introduction narrative.

Change-Id: If2b4341f350191ee0a65bf3a2cab9afa2b76d931
@liujinkun2025 liujinkun2025 force-pushed the docs/optimize-lark-wiki-skill branch from 2e4c765 to 923dc9f Compare June 5, 2026 08:05
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