Docs/lark task shortcut doc refresh - #1057
Conversation
📝 WalkthroughWalkthroughThis PR updates the ChangesTask Shortcut Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
skills/lark-task/SKILL.md (1)
127-165:⚠️ Potential issue | 🟠 Major | ⚡ Quick winRestore attachment scope mapping in the permissions section.
+upload-attachmentis documented above, but this permissions table no longer exposes its required scope (task:attachment:write). That can lead to under-scoped app configs and avoidable auth failures. Please add an explicit attachment API/scope row (or a shortcut-scope row) for this capability.🤖 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-task/SKILL.md` around lines 127 - 165, Add a permissions table row for the attachment API so the required scope is explicit: include an entry mapping `upload-attachment` (or the canonical API name used in docs) to `task:attachment:write` in the same table (or add a shortcut row like `attachments.*` → `task:attachment:write`) so `upload-attachment` is no longer undocumented and apps won't be under-scoped.
🤖 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.
Outside diff comments:
In `@skills/lark-task/SKILL.md`:
- Around line 127-165: Add a permissions table row for the attachment API so the
required scope is explicit: include an entry mapping `upload-attachment` (or the
canonical API name used in docs) to `task:attachment:write` in the same table
(or add a shortcut row like `attachments.*` → `task:attachment:write`) so
`upload-attachment` is no longer undocumented and apps won't be under-scoped.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: fa238a45-f9db-4488-9378-6dfaec15062c
📒 Files selected for processing (2)
shortcuts/task/task_upload_attachment.goskills/lark-task/SKILL.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1057 +/- ##
=======================================
Coverage 67.76% 67.76%
=======================================
Files 590 590
Lines 55194 55194
=======================================
Hits 37400 37400
Misses 14682 14682
Partials 3112 3112 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@819971b54089561f9729c7773d0df773a81023aa🧩 Skill updatenpx skills add zero-my/cli#docs/lark-task-shortcut-doc-refresh -y -g |
* docs: align lark-task attachment descriptions * docs: restore lark-task attachment capability summary
Summary
Align the task attachment wording across the CLI shortcut help text and the
lark-taskskill documentation. This keeps the user-facing description focused on uploading attachments to tasks and cleans up the skill reference layout.Changes
task +upload-attachmentshortcut help text to describe the core task attachment flowskills/lark-task/SKILL.mdshortcut documentation into a table-based formatTest Plan
lark task +upload-attachment --helptext matches the intended descriptionlark-taskskill doc reflects the current shortcut list and wordingRelated Issues
Summary by CodeRabbit