Skip to content

docs(skills): remove unsupported ⚠️ from callout emoji list#1374

Merged
fangshuyu-768 merged 1 commit into
mainfrom
docs/skill-block-insert-after-pitfalls
Jun 10, 2026
Merged

docs(skills): remove unsupported ⚠️ from callout emoji list#1374
fangshuyu-768 merged 1 commit into
mainfrom
docs/skill-block-insert-after-pitfalls

Conversation

@fangshuyu-768

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

Copy link
Copy Markdown
Collaborator

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)

@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

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

This 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 --content, and removes the ⚠️ emoji from the common-emoji list.

Changes

lark-doc reference documentation updates

Layer / File(s) Summary
Block operation API documentation
skills/lark-doc/references/lark-doc-update.md
Added warning that block_insert_after reverses insertion order when reusing the same anchor and an example showing how to chain anchors using new_blocks[0].block_id. Clarified that block_move_after moves only the blocks listed in --src-block-ids, does not move subsequent child content, and does not require --content.
Common emoji reference update
skills/lark-doc/references/lark-doc-xml.md
Removed ⚠️ from the documented "常用 emoji" list.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • SunPeiYang996
  • liangshuo-1

Poem

🐰 I hopped through lines of docs tonight,
Anchors chained to keep inserts right,
Moves now say what stays behind,
One emoji pruned for clearer mind,
📚✨ Tiny changes, tidy light!

🚥 Pre-merge checks | ✅ 3 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title only addresses removing the unsupported ⚠️ emoji, but the PR encompasses three distinct documentation fixes: block_insert_after ordering, block_move_after scope, and the unsupported emoji issue. Update the title to reflect all main changes, e.g., 'docs(skills): warn about block_insert_after ordering, block_move_after scope, and unsupported emoji'.
Description check ⚠️ Warning The description covers only the unsupported emoji change and omits the block_insert_after ordering warnings, block_move_after scope clarifications, and callout placement edge case documented in the PR objectives. Expand the description to include all changes: block_insert_after ordering trap with examples, block_move_after scope clarification, and callout placement edge case warnings.
✅ Passed checks (3 passed)
Check name Status Explanation
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 docs/skill-block-insert-after-pitfalls

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 10, 2026
@fangshuyu-768
fangshuyu-768 force-pushed the docs/skill-block-insert-after-pitfalls branch from 65c7351 to 65f203d Compare June 10, 2026 04:19
@github-actions

github-actions Bot commented Jun 10, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@034a7d5abe2d7f9123a920230239ecc722d1ce84

🧩 Skill update

npx skills add larksuite/cli#docs/skill-block-insert-after-pitfalls -y -g

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
skills/lark-doc/references/lark-doc-update.md (1)

108-128: ⚡ Quick win

Consider showing how to extract block_id from 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 jq or 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

📥 Commits

Reviewing files that changed from the base of the PR and between b07be60 and 65c7351.

📒 Files selected for processing (3)
  • skills/lark-doc/references/lark-doc-update.md
  • skills/lark-doc/references/lark-doc-xml.md
  • skills/lark-doc/references/style/lark-doc-create-workflow.md

Comment thread skills/lark-doc/references/lark-doc-xml.md
@fangshuyu-768
fangshuyu-768 force-pushed the docs/skill-block-insert-after-pitfalls branch 7 times, most recently from ecadc35 to 14a1ccb Compare June 10, 2026 04:36
@fangshuyu-768 fangshuyu-768 changed the title docs(skills): warn about block_insert_after ordering, block_move_after scope, and unsupported emoji docs(skills): improve block_insert_after and block_move_after docs, fix emoji list Jun 10, 2026
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.97%. Comparing base (b07be60) to head (034a7d5).
⚠️ Report is 2 commits behind head on main.

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

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.
@fangshuyu-768
fangshuyu-768 force-pushed the docs/skill-block-insert-after-pitfalls branch from 14a1ccb to 034a7d5 Compare June 10, 2026 06:35
@fangshuyu-768 fangshuyu-768 changed the title docs(skills): improve block_insert_after and block_move_after docs, fix emoji list docs(skills): remove unsupported ⚠️ from callout emoji list Jun 10, 2026
@fangshuyu-768
fangshuyu-768 merged commit e794fd5 into main Jun 10, 2026
30 of 32 checks passed
@fangshuyu-768
fangshuyu-768 deleted the docs/skill-block-insert-after-pitfalls branch June 10, 2026 08:29
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