Skip to content

docs: add known note_id query example to lark-note skill#1977

Open
gengyi1207-bit wants to merge 1 commit into
larksuite:mainfrom
gengyi1207-bit:docs/lark-note-note-id-example
Open

docs: add known note_id query example to lark-note skill#1977
gengyi1207-bit wants to merge 1 commit into
larksuite:mainfrom
gengyi1207-bit:docs/lark-note-note-id-example

Conversation

@gengyi1207-bit

@gengyi1207-bit gengyi1207-bit commented Jul 20, 2026

Copy link
Copy Markdown

Summary

Add a "known note_id" worked example to the lark-note skill doc. The skill's
primary use case is querying note detail when you already hold a note_id, but the
only existing example starts from a meeting_id. This documents the direct
note +detail --note-id path with a concrete output sample.

Changes

  • skills/lark-note/SKILL.md: add a new "direct query by known note_id" section
    right after the existing first scenario. It shows the direct
    note +detail --note-id <note_id> command, a concrete {"note": {...}} output
    sample (fields aligned to shortcuts/note ToMap(), create_time in the
    no-seconds FormatTime format, shared_doc_tokens omitted when empty), and a
    one-line note_display_type routing hint pointing at the existing routing table.

Test Plan

  • Docs-only change: no Go code, flags, output, or command behavior modified
  • Output-sample fields verified against source (shortcuts/note/note.go ToMap(),
    shortcuts/note/note_detail.go output envelope, shortcuts/common/common.go FormatTime)
  • go build, go vet, unit and integration tests pass (unchanged by a docs edit)
  • Structural acceptance review via note +detail --help and --dry-run (no real API calls)

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Added guidance for directly retrieving meeting note details when a note ID is available.
    • Documented the returned note information, including timestamps, creator details, and document tokens.
    • Added instructions for handling normal and unified note types and accessing their transcripts.

@CLAassistant

CLAassistant commented Jul 20, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Jul 20, 2026
@coderabbitai

coderabbitai Bot commented Jul 20, 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: e9f76c8a-2140-4396-8965-70f7d439531b

📥 Commits

Reviewing files that changed from the base of the PR and between 4084091 and e285f00.

📒 Files selected for processing (1)
  • skills/lark-note/SKILL.md

📝 Walkthrough

Walkthrough

新增已知 note_id 时直接查询纪要详情的文档流程,并根据 note_display_type 路由到逐字稿或 unified transcript 获取方式。

Changes

纪要详情查询与逐字稿路由

Layer / File(s) Summary
已知 note_id 的直接查询流程
skills/lark-note/SKILL.md
说明使用 lark-cli note +detail --note-id 查询纪要详情,补充返回字段示例,并按 note_display_type 路由到逐字稿读取或 unified transcript 处理。

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

  • larksuite/cli#1961:在同一技能文档中补充已知 note_id 的直接查询和纪要类型路由流程。

Suggested labels: domain/vc

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the docs-only change.
Description check ✅ Passed The description follows the required template and includes all required sections with relevant details.
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.
✨ 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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