Skip to content

docs(skills): migrate docs +search to drive +search and fix creator_ids owner semantic#951

Merged
liujinkun2025 merged 1 commit into
mainfrom
feat/doc-search
May 20, 2026
Merged

docs(skills): migrate docs +search to drive +search and fix creator_ids owner semantic#951
liujinkun2025 merged 1 commit into
mainfrom
feat/doc-search

Conversation

@liujinkun2025
Copy link
Copy Markdown
Collaborator

@liujinkun2025 liujinkun2025 commented May 18, 2026

Background

docs +search is in maintenance and will be removed; cloud-space resource discovery is consolidated onto drive +search. This PR makes two related documentation/help-text quality fixes.

Changes

1. Redirect guidance: docs +search → drive +search

Switch the skills/templates that still actively steer users to docs +search over to drive +search (the already-correct "deprecated" notices and the B-class fallback doc lark-doc-search.md are left as-is):

  • skill-template/domains/{doc,sheets}.md
  • skills/lark-base/SKILL.md: --filter '{"doc_types":["BITABLE"]}'--doc-types bitable; reference link repointed to lark-drive
  • skills/lark-sheets/SKILL.md: body + frontmatter description, add drive-search reference link

Both hit the same server API (POST /open-apis/search/v2/doc_wiki/search) with equivalent capability; this only flattens the entry from nested --filter JSON to flags.

2. Fix creator_ids/--mine semantic: creator → owner

The server matches search creator_ids (incl. --mine / --creator-ids) by owner (document owner) semantics — despite the OpenAPI field name creator, it is not the original creator (a doc created then transferred out won't match; one transferred to me will). Corrected the misleading wording:

  • shortcuts/drive/drive_search.go: --help Desc and Tip for --mine / --creator-ids (user-visible)
  • skills/lark-drive/references/lark-drive-search.md: identity section, param table, decision rules, examples
  • skills/lark-drive/SKILL.md: top-level guidance
  • skills/lark-doc/references/lark-doc-search.md: creator_ids usage note (now consistent with the same file's "owner" wording)

The wire field name creator_ids is kept unchanged (aligned with the server).

Impact / Validation

  • Docs / help strings only, no logic change
  • gofmt -l clean, go vet ./shortcuts/drive/ passes, package builds
  • Out of scope (left untouched): creator_id/creator in lark-base/*workflow*, lark-vc-notes, lark-task — genuine "creator" fields of other, unrelated APIs

Summary by CodeRabbit

  • Documentation
    • Use "drive +search" (not "docs +search") to find tables, spreadsheets, bases and other cloud-space objects; "docs +search" is deprecated.
    • Clarified --mine as owner-based (documents you own) and --creator-ids/creator_ids as owner open_id matching; they are mutually exclusive.
    • Emphasized drive +search returns SHEET results and to switch to the corresponding app (e.g., sheets) after locating a spreadsheet.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 18, 2026

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 CLI help and multiple skill docs to make --mine/--creator-ids owner-based for drive +search, clarifies mutual exclusivity, and routes spreadsheet/base discovery through lark-cli drive +search instead of docs +search.

Changes

Drive search semantics and routing consolidation

Layer / File(s) Summary
Drive CLI help and Tips
shortcuts/drive/drive_search.go
--mine and --creator-ids help/Tips updated to owner-based wording and mutual-exclusion clarified.
Drive reference semantics and mappings
skills/lark-drive/references/lark-drive-search.md, skills/lark-drive/SKILL.md
--mine documented to populate current user's open_id into creator_ids; examples and NL→flag mappings updated; --mine and --creator-ids made mutually exclusive.
Lark-doc creator_ids clarification
skills/lark-doc/references/lark-doc-search.md
creator_ids filter clarified as owner-matching (not initial creator); guidance to resolve open_id via lark-contact.
Cloud-space discovery routing across skills/templates
skills/lark-sheets/SKILL.md, skills/lark-base/SKILL.md, skill-template/domains/sheets.md, skill-template/domains/doc.md, skills/lark-doc/SKILL.md
Replaced docs +search with drive +search for locating SHEET/BITABLE resources and updated decision-flow guidance to switch to the corresponding business skill for in-object operations.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

  • larksuite/cli#708: Overlaps on Base discovery/routing guidance for BITABLE search.
  • larksuite/cli#658: Related to drive +search identity flag parsing and owner semantics.

Suggested labels

documentation, size/M

Suggested reviewers

  • fangshuyu-768
  • kongenpei

Poem

🐰 I hopped through flags and docs today,

From "first-made" to "who owns" — I cleared the way.
Drive now finds sheets and bases true,
One search to start, then the skill to do.
Hooray — the rabbit fixed the clue!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the two main changes: migrating docs +search guidance to drive +search and fixing creator_ids/--mine semantic documentation from creator to owner.
Description check ✅ Passed The PR description covers summary, detailed changes with file-level impact, and validation approach. However, the 'Test Plan' section from the template is not present or completed.
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
  • Commit unit tests in branch feat/doc-search

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/base PR touches the base domain domain/ccm PR touches the ccm domain size/L Large or sensitive change across domains or core paths labels May 18, 2026
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 18, 2026

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@9ed4a1dc417a3c122a308ae696ed55550b35e218

🧩 Skill update

npx skills add larksuite/cli#feat/doc-search -y -g

@liujinkun2025 liujinkun2025 changed the title docs(skills): migrate docs +search → drive +search & fix creator_ids owner semantic docs(skills): migrate docs +search to drive +search and fix creator_ids owner semantic May 18, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented May 18, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.58%. Comparing base (27a5eed) to head (9ed4a1d).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #951   +/-   ##
=======================================
  Coverage   67.58%   67.58%           
=======================================
  Files         575      575           
  Lines       54269    54269           
=======================================
  Hits        36679    36679           
  Misses      14548    14548           
  Partials     3042     3042           

☔ View full report in Codecov by Sentry.
📢 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.

@liujinkun2025 liujinkun2025 force-pushed the feat/doc-search branch 6 times, most recently from 1ef5472 to 168850c Compare May 20, 2026 04:45
…ds owner semantic

docs +search is in maintenance and will be removed; cloud-space resource
discovery is consolidated onto drive +search. Two related doc/help fixes:

1. Redirect guidance: docs +search -> drive +search
   - skill-template/domains/{doc,sheets}.md
   - lark-base/SKILL.md: --filter '{"doc_types":["BITABLE"]}' -> --doc-types bitable
   - lark-sheets/SKILL.md: body + frontmatter description, add drive-search ref link
   Same server API, equivalent capability; only flattens the entry from
   nested --filter JSON to flags. reference links repointed to lark-drive.

2. Fix creator_ids/--mine semantic: creator -> owner
   The server matches creator_ids (incl. --mine / --creator-ids) by owner
   (document owner), not original creator, despite the OpenAPI field name.
   - shortcuts/drive/drive_search.go: --help Desc and Tip
   - lark-drive/references/lark-drive-search.md: identity section, params, rules, examples
   - lark-drive/SKILL.md: top-level guidance
   - lark-doc/references/lark-doc-search.md: creator_ids usage note (now self-consistent)
   Wire field name creator_ids kept (aligned with the server).

Docs/help strings only, no logic change; gofmt / go vet / package build pass.

Change-Id: If3ebf5a247b7e38b58050c677dc888a310f1c6b6
@liujinkun2025 liujinkun2025 merged commit 9272b9d into main May 20, 2026
21 checks passed
@liujinkun2025 liujinkun2025 deleted the feat/doc-search branch May 20, 2026 07:08
@liangshuo-1 liangshuo-1 mentioned this pull request May 20, 2026
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base domain domain/ccm PR touches the ccm 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.

2 participants