docs: clarify docs search query usage

[wittam-01]

Summary

Clarify the docs +search shortcut documentation so agents pass search keywords via --query instead of using positional arguments.

Changes

• add an explicit warning and correct/incorrect examples for --query
• update the parameter description to require --query for keyword searches
• add a decision rule that forbids positional keyword usage

Test Plan

• Unit tests passed
• Manual verification of the documentation update
• Confirmed the repository has a clean working tree after the commit

Related Issues

N/A

Summary by CodeRabbit

• Documentation
  • Clarified search docs to require using the --query flag for keyword searches (includes correct/incorrect usage examples), updated the --query parameter description to stress this requirement, and added a decision rule explicitly disallowing positional keyword forms—use commands like: lark-cli docs +search --query "<关键词>" to ensure correct, non-empty search results.

[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: 07f35d85-f24e-46fd-ad84-317e0c525bd7

📥 Commits

Reviewing files that changed from the base of the PR and between 4cb12ad and def07b7.

📒 Files selected for processing (1)

• skills/lark-doc/references/lark-doc-search.md

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

• skills/lark-doc/references/lark-doc-search.md

---

📝 Walkthrough

Walkthrough

Documentation clarifies that search keywords for lark-doc must be supplied via the --query flag (e.g., lark-cli docs +search --query "<关键词>"), not as positional arguments; includes examples and updated decision rules to prevent empty or incorrect searches.

Changes

Cohort / File(s)	Summary
Documentation Updates skills/lark-doc/references/lark-doc-search.md	Added explicit constraint requiring --query for keyword searches with correct/incorrect examples, updated --query <text> parameter description, and extended decision rules to forbid positional keyword forms.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 I nibble on docs and tidy the way,
I whisper: use --query when you play,
No stray keywords hopping out of line,
Clear searches now — swift, tidy, and fine.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: clarify docs search query usage' directly and specifically summarizes the main change—clarifying documentation for search query usage.
Description check	✅ Passed	The description includes all required template sections: Summary, Changes, Test Plan, and Related Issues with sufficient detail about the documentation updates.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ 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 docs/clarify-doc-search-query-flag

---

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

[greptile-apps]

Greptile Summary

This PR tightens the docs +search reference documentation by adding three coordinated guardrails that collectively prevent AI agents from generating positional-argument invocations of the CLI.

• Warning block (lines 19–22): Adds a > **关键约束** callout immediately before the command examples, providing a correct/incorrect usage pair and an unconditional statement that positional keywords won't be routed into query.
• Parameter table (line 54): Appends an inline bold rule to the --query description reinforcing that any keyword must be passed explicitly via the flag, not as a trailing positional argument.
• Decision rule (line 67): Inserts a new bullet with absolute language (必须) forbidding positional-keyword generation patterns.

All three additions are internally consistent and use unambiguous, unconditional phrasing throughout. The change is documentation-only with no impact on runtime behavior.

Confidence Score: 5/5

Safe to merge — documentation-only change with clear, consistent, and unconditionally phrased guidance.

All three added sections (warning block, parameter description, decision rule) use unconditional language and are mutually consistent. No runtime behavior is changed, and no logical contradictions or hedging language were found.

No files require special attention.

Important Files Changed

Filename	Overview
skills/lark-doc/references/lark-doc-search.md	Documentation clarification adding an explicit warning block, updated parameter description, and a new decision rule — all consistently requiring --query for keyword arguments. No logic issues found.

Flowchart

%%{init: {'theme': 'neutral'}}%%
flowchart TD
    A([Agent receives search request]) --> B{User provided\na search keyword?}
    B -- Yes --> C[Build command with\n--query flag]
    B -- No --> D[Empty search:\nlark-cli docs +search]
    C --> E["lark-cli docs +search --query \"keyword\""]
    D --> F[Returns default results]
    E --> G[Returns keyword-matched results]
    X([Forbidden]) --> Y["lark-cli docs +search keyword\n(positional argument)"]
    Y --> Z["Won't enter query →\nempty search or unexpected results"]

Loading

_{Reviews (2): Last reviewed commit: "docs: clarify docs search query usage" | Re-trigger Greptile}

[github-actions]

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs/clarify-doc-search-query-flag -y -g