docs: slim lark-event references to recipes and gotchas

[liuxinyanglxy]

Summary

Refocuses the lark-event skill on what the CLI cannot express. Structure (key catalog, fields, types, enums, scopes, per-key identity) is discoverable via event list / event schema, so the references no longer duplicate it — they keep only jq recipes, domain semantic gotchas, required params, and identity reminders.

Changes

• skills/lark-event/references/lark-event-im.md: drop the 11-key catalog and field/shape tables; keep jq recipes + .content decoding gotchas (~43% smaller)
• skills/lark-event/references/lark-event-vc.md: document the 3 recording keys, then replace the hardcoded catalog with a pointer to event list; keep behavior gotchas + recipes (~70% smaller)
• skills/lark-event/references/lark-event-minutes.md: drop catalog/scope/field tables; keep the enrichment gotcha + recipes (~43% smaller)
• skills/lark-event/references/lark-event-whiteboard.md: drop catalog/scope/field/lifecycle tables; keep the required -p whiteboard_id gotcha, the user_id conditional-presence note (not in schema), and recipes (~52% smaller)
• skills/lark-event/SKILL.md: reword Topic index rows to advertise recipes/gotchas and route structure lookups to the CLI

Test Plan

• skipped: make unit-test — docs-only change, no Go code modified
• skipped: validate / local-eval / acceptance-reviewer — docs-only change
• manual verification: command-correctness eval (skill + CLI available, deterministic key/identity/params/jq check) across all 4 event domains — 21/21 correct, 0 identity errors, whiteboard -p whiteboard_id preserved, VC recording-transcript key resolves

Related Issues

N/A

Summary by CodeRabbit

• Documentation
  • Streamlined event reference docs with clearer, gotcha-focused guidance for IM, VC, Minutes, and Whiteboard.
  • Clarified payload behaviors (e.g., message content is pre-rendered text except interactive cards) and sender identity semantics.
  • Explicit guidance on required access flags (when to use user vs bot) and whiteboard subscription parameter requirements.
  • Documented enrichment/failure behaviors and VC meeting/recording edge cases.
  • Condensed catalogs into concise consumption recipes and practical jq filtering examples.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f5453f02-6bfe-40b5-82f9-b0c29a93054a

📥 Commits

Reviewing files that changed from the base of the PR and between e87deef and 1a09c5f.

📒 Files selected for processing (5)

• skills/lark-event/SKILL.md
• skills/lark-event/references/lark-event-im.md
• skills/lark-event/references/lark-event-minutes.md
• skills/lark-event/references/lark-event-vc.md
• skills/lark-event/references/lark-event-whiteboard.md

✅ Files skipped from review due to trivial changes (1)

• skills/lark-event/references/lark-event-vc.md

🚧 Files skipped from review as they are similar to previous changes (4)

• skills/lark-event/references/lark-event-whiteboard.md
• skills/lark-event/references/lark-event-minutes.md
• skills/lark-event/SKILL.md
• skills/lark-event/references/lark-event-im.md

---

📝 Walkthrough

Walkthrough

Documentation refactor trims per-key catalogs across IM, VC, Minutes, and Whiteboard guides, consolidating schema discovery to lark-cli and emphasizing payload “gotchas” and practical lark-cli --jq consumption examples.

Changes

Event Documentation Restructuring

Layer / File(s)	Summary
Event Documentation Index Update skills/lark-event/SKILL.md	Topic index entries for IM, VC, Minutes, and Whiteboard updated to point to reworked references, highlighting jq recipe scope, payload gotchas (e.g., .content pre-rendered), and required flags (--as user for VC, -p whiteboard_id for Whiteboard).
IM Event Consumption Documentation skills/lark-event/references/lark-event-im.md	Removed in-file catalog in favor of CLI-based schema discovery. Clarifies flat vs V2-enveloped keys, .content pre-rendering except interactive, silent drop on fromjson errors for non-interactive messages, sender_id = open_id, and condensed jq recipes for common filters.
Minutes Event Consumption Documentation skills/lark-event/references/lark-event-minutes.md	Focuses on consumption semantics: enrichment/degradation behavior (base fields present; title may be empty on detail-API failure), minute_source only for meeting-sourced minutes, and updated --jq examples for filtering enriched/meeting-sourced minutes.
VC Event Consumption Documentation skills/lark-event/references/lark-event-vc.md	Removed field catalogs; points readers to CLI for schemas. States all VC keys require --as user. Documents gotchas for meeting-ended time conversion, note enrichment/note_source, recording.* pairing and transcript batching, with jq examples.
Whiteboard Event Consumption Documentation skills/lark-event/references/lark-event-whiteboard.md	Shortened onboarding-style doc referencing SKILL.md and event schema; notes V2 envelope, required per-whiteboard -p whiteboard_id=<whiteboard_token> parameter and access validation, and retains pared-down jq recipes.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Possibly related PRs

• larksuite/cli#1159: Implementation of vc.note.generated_v1 event subscription and enrichment wiring referenced by updated VC guidance.

Suggested labels

documentation, domain/vc

Suggested reviewers

• fangshuyu-768
• liangshuo-1
• zhangjun-bytedance

Poem

🐰 From dense tables to focused light,
event gotchas now sit in sight—
jq recipes compact and bright,
CLI points the schema right,
hop, parse, and ship with delight!

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: slim lark-event references to recipes and gotchas' directly and clearly summarizes the main change—condensing documentation by removing duplicated structural content and retaining only recipes and semantic gotchas.
Description check	✅ Passed	The description is comprehensive, providing detailed motivation (avoiding CLI duplication), specific file changes with impact metrics, a clear test plan with manual verification results, and related issues reference. All required template sections are present and well-filled.
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 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.32%. Comparing base (3f77ede) to head (1a09c5f).
⚠️ Report is 26 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #1451      +/-   ##
==========================================
+ Coverage   72.82%   73.32%   +0.49%     
==========================================
  Files         731      750      +19     
  Lines       69096    69240     +144     
==========================================
+ Hits        50320    50769     +449     
+ Misses      14999    14733     -266     
+ Partials     3777     3738      -39     

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

[github-actions]

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@1a09c5fc7f7db2401e7ebeee4eb6ef0e5db1b420

🧩 Skill update

npx skills add liuxinyanglxy/cli#docs/lark-event-skill-slim -y -g

[coderabbitai]

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-event/SKILL.md`:
- Line 151: Update the VC coverage row wording to explicitly state that the VC
field note_source is conditional by source_type; replace the current
“note_source meeting-only” phrasing with a clearer phrase such as “note_source
only present when source_type == 'meeting'” (mirroring the language used in
references/lark-event-vc.md) so it cannot be confused with the Minutes row’s
wording.

🪄 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: 124501cd-bd8a-4271-bfb8-a72198f2bd16

📥 Commits

Reviewing files that changed from the base of the PR and between deb0bd9 and d60796e.

📒 Files selected for processing (5)

• skills/lark-event/SKILL.md
• skills/lark-event/references/lark-event-im.md
• skills/lark-event/references/lark-event-minutes.md
• skills/lark-event/references/lark-event-vc.md
• skills/lark-event/references/lark-event-whiteboard.md