docs(skills): remove unsupported ⚠️ from callout emoji list#1374
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 reference docs: it adds a warning and chained-anchor example for block_insert_after, clarifies block_move_after only moves explicitly listed blocks and does not require Changeslark-doc reference documentation updates
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (2 warnings)
✅ Passed checks (3 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 |
65c7351 to
65f203d
Compare
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@034a7d5abe2d7f9123a920230239ecc722d1ce84🧩 Skill updatenpx skills add larksuite/cli#docs/skill-block-insert-after-pitfalls -y -g |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
skills/lark-doc/references/lark-doc-update.md (1)
108-128: ⚡ Quick winConsider showing how to extract
block_idfrom the response.The example explains the chained-anchor pattern well, but the comment "拿到返回的 new_blocks[0].block_id → '2.1 的 block_id'" doesn't show how users should extract that value from the JSON response between calls. Users unfamiliar with JSON parsing might not know they need
jqor manual parsing.💡 Example showing the complete workflow with JSON extraction
> ```bash > # 第 1 次:插在 h1 之后 -> lark-cli docs +update ... --command block_insert_after \ +> response=$(lark-cli docs +update ... --command block_insert_after \ > --block-id "<h1_block_id>" \ -> --content '<h2>2.1</h2><p>...</p>' -> # 拿到返回的 new_blocks[0].block_id → "2.1 的 block_id" +> --content '<h2>2.1</h2><p>...</p>') +> # 从响应中提取新插入块的 block_id +> block_id_2_1=$(echo "$response" | jq -r '.data.document.new_blocks[0].block_id') > > # 第 2 次:插在 2.1 之后 > lark-cli docs +update ... --command block_insert_after \ -> --block-id "2.1 的 block_id" \ +> --block-id "$block_id_2_1" \ > --content '<h2>2.2</h2><p>...</p>' > ```🤖 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-doc/references/lark-doc-update.md` around lines 108 - 128, Add a concrete example showing how to capture and parse the JSON response from the lark-cli call and extract new_blocks[0].block_id between calls: call lark-cli docs +update and save its stdout into a shell variable (e.g., response), then show extracting the id with jq (e.g., jq -r '.data.document.new_blocks[0].block_id') into a variable (e.g., block_id_2_1) and reusing that variable as the --block-id for the next block_insert_after call; reference the response, new_blocks[0].block_id, and the lark-cli docs +update invocation so readers know exactly where to plug the jq extraction step.
🤖 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/lark-doc-xml.md`:
- Line 99: There is a cross-file inconsistency between the supported <callout>
emoji list in skills/lark-doc/references/lark-doc-xml.md (which omits "⚠️") and
the style guidance in skills/lark-doc/references/style/lark-doc-style.md (which
prescribes "⚠️❌" for warnings/errors); decide whether "⚠️" should be a supported
value for the <callout> emoji attribute or should only appear inside callout
text, then make the files consistent: either add "⚠️" to the emoji enumeration
and update any examples/notes in lark-doc-xml.md (and ensure schema/docs mention
it as valid for the emoji attribute), or change the style doc to recommend an
allowed emoji from the existing list (e.g., use "❗" or "❌") and update examples
in lark-doc-style.md to match the supported values; update both files’ examples
and any descriptive text so the <callout> tag's emoji attribute and the style
guidance are aligned.
---
Nitpick comments:
In `@skills/lark-doc/references/lark-doc-update.md`:
- Around line 108-128: Add a concrete example showing how to capture and parse
the JSON response from the lark-cli call and extract new_blocks[0].block_id
between calls: call lark-cli docs +update and save its stdout into a shell
variable (e.g., response), then show extracting the id with jq (e.g., jq -r
'.data.document.new_blocks[0].block_id') into a variable (e.g., block_id_2_1)
and reusing that variable as the --block-id for the next block_insert_after
call; reference the response, new_blocks[0].block_id, and the lark-cli docs
+update invocation so readers know exactly where to plug the jq extraction step.
🪄 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: e6fd0871-350c-4567-9228-4927c5f206ba
📒 Files selected for processing (3)
skills/lark-doc/references/lark-doc-update.mdskills/lark-doc/references/lark-doc-xml.mdskills/lark-doc/references/style/lark-doc-create-workflow.md
ecadc35 to
14a1ccb
Compare
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1374 +/- ##
==========================================
+ Coverage 71.96% 71.97% +0.01%
==========================================
Files 695 696 +1
Lines 65879 65891 +12
==========================================
+ Hits 47408 47424 +16
+ Misses 14814 14811 -3
+ Partials 3657 3656 -1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
The API silently falls back to the default 💡 when⚠️ is used in a callout. Remove it from the supported emoji list to prevent agents from using it.
14a1ccb to
034a7d5
Compare
Summary
The API silently falls back to the default 💡 when⚠️ is used in a callout. Remove it from the supported emoji list to prevent agents from using it.
Verified with a test document: 💡, ❗, ✅, ❌ all work correctly;⚠️ is silently replaced with 💡.
Files changed
skills/lark-doc/references/lark-doc-xml.md(+1/-1)