docs: clarify block anchor links in lark-doc skill - #1120
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThis PR updates lark-doc docs: SKILL.md now requires returning block direct links as ChangesURL Anchor Block ID Usage Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
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 docstrings
🧪 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.
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-doc/references/style/lark-doc-update-workflow.md`:
- Line 22: The suggested anchor-handling command is missing the required
document identifier so it cannot run as written; extract the base document
URL/token (strip the `#...` anchor) from the user-provided `docx/wiki
URL#block_id` and add it to the fetch invocation (i.e., include the `--doc
<base_doc_url_or_token>` flag) when calling `docs +fetch --api-version v2
--scope section --start-block-id <anchor_block_id> --detail with-ids`, and keep
the existing fallback behavior to use a `range` fetch for very small local
edits.
In `@skills/lark-doc/SKILL.md`:
- Around line 20-21: Update the CLI example so the --doc flag only receives the
base document URL/token (no '#' anchor) and pass the block anchor separately via
--start-block-id or --block-id; specifically change the example command using
the lark-cli docs +fetch --api-version v2 invocation so it becomes something
like --doc "https://xxx.feishu.cn/docx/doxcnXXX" --start-block-id "blkcnAnchor"
(or --block-id "blkcnAnchor") and remove any '`#blkcnAnchor`' from the --doc
value.
🪄 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: 9c56e460-070e-4d77-aa4b-318aa105969e
📒 Files selected for processing (4)
skills/lark-doc/SKILL.mdskills/lark-doc/references/lark-doc-fetch.mdskills/lark-doc/references/lark-doc-update.mdskills/lark-doc/references/style/lark-doc-update-workflow.md
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1120 +/- ##
==========================================
+ Coverage 68.10% 68.11% +0.01%
==========================================
Files 613 613
Lines 56396 56396
==========================================
+ Hits 38409 38415 +6
+ Misses 14809 14804 -5
+ Partials 3178 3177 -1 ☔ 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@5d8f56e9798c8942b4dcd55204d38f629ca65248🧩 Skill updatenpx skills add larksuite/cli#fix/doc-skill-anchor-url-guidance -y -g |
07738a3 to
7bfac9b
Compare
fc0f811 to
23f75d4
Compare
23f75d4 to
5d8f56e
Compare
Summary
This PR clarifies one focused piece of guidance in the lark-doc skill: when a user asks for a direct link to a specific block, the agent should return
document_base_url#block_id.What changed
skills/lark-doc/SKILL.mdfor returning文档基础 URL#block_idskills/lark-doc/references/lark-doc-fetch.mdthat--detail with-idscan provide theblock_idneeded to build that linkWhy
The intent is only to teach the agent how to form a direct block link. This PR does not expand anchor handling into broader document fetch or update workflows.