docs(base): restructure skill routing and analysis guidance - #2320
Conversation
|
Note Reviews pausedIt 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 Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughThe PR updates Base shortcut payloads and hints, upgrades the lark-base skill to version 1.2.6, revises field, record, filtering, and analysis references, removes obsolete guidance and contract tests, and adds NDJSON dry-run pagination coverage. ChangesBase guidance alignment
Estimated code review effort: 3 (Moderate) | ~25 minutes Mergeability Score: ⚪ Minimal · up to The change primarily restructures guidance while preserving the existing public shortcuts, and no actionable merge-blocking risk remains after normal checks and review. Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 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-base/references/lark-base-data-analysis-sop.md`:
- Around line 63-65: Update the manifest reuse guidance in the batch extraction
workflow to always compare each manifest’s rev with the current table rev
whenever freshness affects correctness, rather than relying on elapsed time or
write frequency. Re-export the table when the revisions differ; if best-effort
reuse remains permitted, explicitly state that the reused result may be stale.
In `@skills/lark-base/references/lark-base-field-json.md`:
- Around line 431-436: 更新“+field-update”说明,明确完整 PUT
仅回写更新接口支持的可写属性;使用“+field-get”读取定义后,排除仅创建时支持的 dynamic_options_source
及其他只读属性,不要将这些字段传入更新请求。
In `@skills/lark-base/references/lark-base-field-update.md`:
- Around line 120-125: Update the blacklist exception guidance in the
field-update documentation to allow exceptions only for platform-explicitly
supported scenarios, while keeping blacklist restrictions effective for empty
columns and user-accepted data loss. Explicitly exclude link-type changes and
dynamic/static option-source switches from all exceptions.
In `@skills/lark-base/references/lark-base-record-batch-create.md`:
- Around line 54-58: Update the batch-create examples associated with the
visible status field `"状态":"Open"` so status CellValues use the established
array-valued shape, matching the shortcut help and regression-test contract.
Apply the correction to both occurrences around the examples near Lines 16 and
40, without changing unrelated fields or CLI behavior.
🪄 Autofix
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 Plus
Run ID: 865d670c-51fb-467d-9ef1-535318520917
📒 Files selected for processing (19)
shortcuts/base/base_execute_test.goshortcuts/base/base_resolve.goshortcuts/base/base_resolve_test.goshortcuts/base/base_shortcuts_test.goshortcuts/base/base_skill_contract_test.goshortcuts/base/data_query_guide_contract_test.goshortcuts/base/field_create.goshortcuts/base/record_batch_create.goshortcuts/base/record_upsert.goskills/lark-base/SKILL.mdskills/lark-base/references/lark-base-cell-value.mdskills/lark-base/references/lark-base-data-analysis-sop.mdskills/lark-base/references/lark-base-field-create.mdskills/lark-base/references/lark-base-field-json.mdskills/lark-base/references/lark-base-field-update.mdskills/lark-base/references/lark-base-filter-condition.mdskills/lark-base/references/lark-base-record-batch-create.mdskills/lark-base/references/lark-base-record-batch-update.mdskills/lark-base/references/lark-base-record-upsert.md
💤 Files with no reviewable changes (4)
- skills/lark-base/references/lark-base-record-upsert.md
- shortcuts/base/data_query_guide_contract_test.go
- shortcuts/base/base_skill_contract_test.go
- shortcuts/base/base_execute_test.go
There was a problem hiding this comment.
♻️ Duplicate comments (1)
skills/lark-base/references/lark-base-field-json.md (1)
431-436: 🗄️ Data Integrity & Integration | 🟠 MajorExclude creation-only and UI-only properties from the full PUT.
The
+field-updateguidance must limit full write-back to properties supported by the update API. This page states thatdynamic_options_sourceis creation-only at Line 240 and that several properties are UI-only at Lines 241 and 339. Explicitly exclude those properties from the read-modify-write payload. Otherwise, the documented workflow can produce rejected update requests or inconsistent field definitions.🤖 Prompt for 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. In `@skills/lark-base/references/lark-base-field-json.md` around lines 431 - 436, Update the +field-update guidance to exclude creation-only dynamic_options_source and the UI-only properties identified in the field documentation from the full PUT payload. In the read-modify-write workflow, retain only properties supported by the update API while preserving the existing supported field-definition attributes and --yes requirement.
🤖 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.
Duplicate comments:
In `@skills/lark-base/references/lark-base-field-json.md`:
- Around line 431-436: Update the +field-update guidance to exclude
creation-only dynamic_options_source and the UI-only properties identified in
the field documentation from the full PUT payload. In the read-modify-write
workflow, retain only properties supported by the update API while preserving
the existing supported field-definition attributes and --yes requirement.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: 660612ae-868a-4971-8160-51e84fbf22a5
📒 Files selected for processing (2)
skills/lark-base/references/lark-base-field-json.mdskills/lark-base/references/lark-base-field-update.md
🚧 Files skipped from review as they are similar to previous changes (1)
- skills/lark-base/references/lark-base-field-update.md
…ommon-fewshots # Conflicts: # skills/lark-base/references/lark-base-filter-condition.md
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@4a856d6cef2c25272c49b86a04b92f0526164543🧩 Skill updatenpx skills add zgz2048/cli#codex/base-filter-common-fewshots -y -g |
There was a problem hiding this comment.
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 `@shortcuts/base/base_dryrun_ops_test.go`:
- Around line 134-145: Add self-contained CLI-level dry-run E2E cases in
TestDryRunRecordOps for both NDJSON record-list and record-search paths, rather
than invoking dryRunRecordList or dryRunRecordSearch directly. Exercise shortcut
mounting, validation, and the CLI dry-run envelope while preserving assertions
for the expected endpoint and NDJSON query parameters.
🪄 Autofix
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 Plus
Run ID: 7c250195-3c89-4a1d-9b1d-2b61a2b81f55
📒 Files selected for processing (2)
shortcuts/base/base_dryrun_ops_test.goshortcuts/base/record_ops.go
…ommon-fewshots # Conflicts: # skills/lark-base/SKILL.md
Summary
base-block-list, typed NDJSON, predicate pushdown,revreuse, jq/Python selection, and explicit NULL semanticsrecord-upsertshortcut available through its own helpWhy
The previous entry skill was a flat command catalog with important Base concepts and routing rules spread across references. Agents frequently over-read documentation, selected legacy single-record writes, confused Base blocks with dashboard blocks, repeated artifact checks, or treated low-frequency field details as the primary workflow.
This change makes the entry skill a compact resource map, keeps module-specific contracts in their references, and preserves the Base-specific facts that a database/data-analysis model cannot infer from generic SQL or DataFrame knowledge.
User and agent impact
Validation
git diff --checkgo test ./shortcuts/base/... ./internal/skillcontent/...Experimental findings incorporated
record_idguaranteesSummary by CodeRabbit