Skip to content

docs(im): document same-card completion renotification#1607

Open
xu91102 wants to merge 2 commits into
larksuite:mainfrom
xu91102:docs/cardkit-same-card-renotify
Open

docs(im): document same-card completion renotification#1607
xu91102 wants to merge 2 commits into
larksuite:mainfrom
xu91102:docs/cardkit-same-card-renotify

Conversation

@xu91102

@xu91102 xu91102 commented Jun 26, 2026

Copy link
Copy Markdown
Contributor

Summary

Document the same-card CardKit completion re-notification pattern for long-running agent replies.

Changes

  • Add IM skill guidance that completion re-notification should update the existing card/message instead of sending a new message.
  • Document the same-card sequence, invariants, token failure behavior, and duplicate-notification guard in the card action reference.
  • Cross-link the IM event reference to the same-card completion guidance.

Test Plan

  • bash scripts/check-doc-tokens.sh skills/lark-im/SKILL.md skills/lark-im/references/lark-im-card-action-reply.md skills/lark-event/references/lark-event-im.md
  • node scripts/skill-format-check/index.js
  • bash scripts/check-skill-wire-vocab.sh
  • git diff --check
  • bash scripts/check-doc-tokens.sh skills (pre-existing token placeholder failures outside this PR: lark-wiki, lark-base, lark-approval references)

Related Issues

Summary by CodeRabbit

  • Documentation
    • Added clearer guidance for long-running Interactive CardKit replies to send completion re-notifications as an update to the same card/message, preserving existing thread context.
    • Introduced a dedicated “same-card completion re-notification” section covering required invariants and constraints when delayed updates aren’t available.
    • Updated the sender-filter example with step-by-step instructions to retrieve your own open_id and to look up other users’ open_id values.

@coderabbitai

coderabbitai Bot commented Jun 26, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e11fd16d-1af1-4cfb-b902-34a139fb3c15

📥 Commits

Reviewing files that changed from the base of the PR and between 4ba55bb and 0825f1d.

📒 Files selected for processing (1)
  • skills/lark-im/references/lark-im-card-action-reply.md
✅ Files skipped from review due to trivial changes (1)
  • skills/lark-im/references/lark-im-card-action-reply.md

📝 Walkthrough

Walkthrough

Docs add same-card completion re-notification guidance for long-running CardKit replies and clarify a sender-filter example for obtaining open_id values.

Changes

Same-card completion guidance

Layer / File(s) Summary
Completion re-notification docs
skills/lark-im/references/lark-im-card-action-reply.md, skills/lark-im/SKILL.md, skills/lark-event/references/lark-event-im.md
Adds the same-card completion re-notification pattern for CardKit streaming replies, including constraints on preserving message/card identity and a reference to the detailed section.

Sender-filter open_id guidance

Layer / File(s) Summary
open_id example wording
skills/lark-event/references/lark-event-im.md
Clarifies how to fetch the caller’s open_id and how to search other users’ open_id values in the sender-filter example.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested reviewers

  • YangJunzhou-01

Poem

A bunny hopped through docs so bright,
One card stayed true, then shone twice right.
No extra chatter, no message parade,
Just same-card sparkle, neatly laid.
🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: documenting same-card completion re-notification for CardKit streaming.
Description check ✅ Passed The description follows the template with Summary, Changes, Test Plan, and Related Issues filled in.
Linked Issues check ✅ Passed The docs address the issue’s core requirements: same-card completion refresh, no new message, identity preservation, and update-failure behavior.
Out of Scope Changes check ✅ Passed The pull request appears limited to documentation updates that directly support the linked CardKit guidance.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@github-actions github-actions Bot added domain/im PR touches the im domain size/L Large or sensitive change across domains or core paths labels Jun 26, 2026

@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

🤖 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-im/references/lark-im-card-action-reply.md`:
- Around line 141-159: Clarify the “card can no longer be updated” case in the
same-card completion re-notification guidance by naming the concrete API
errors/conditions that count as terminal update failures. Update the `Same-card
completion re-notification` section to explicitly mention the relevant
`card.action.trigger` delayed-update flow and the API failure cases (for example
expired/exhausted/missing token, message not found, permission denied) so
implementers know when to stop retrying and avoid falling back to `im
+messages-send` / `im +messages-reply`.
🪄 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: 65747156-4c5d-43bc-a43b-8090b9e15d29

📥 Commits

Reviewing files that changed from the base of the PR and between d9330b7 and 4ba55bb.

📒 Files selected for processing (3)
  • skills/lark-event/references/lark-event-im.md
  • skills/lark-im/SKILL.md
  • skills/lark-im/references/lark-im-card-action-reply.md

Comment thread skills/lark-im/references/lark-im-card-action-reply.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/im PR touches the im domain size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document/support same-card completion re-notification for CardKit streaming

1 participant