Skip to content

docs: optimize base skill references#1171

Merged
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/base-skill-reference-optimization
Jun 2, 2026
Merged

docs: optimize base skill references#1171
zgz2048 merged 1 commit into
larksuite:mainfrom
zgz2048:codex/base-skill-reference-optimization

Conversation

@zgz2048

@zgz2048 zgz2048 commented May 29, 2026

Copy link
Copy Markdown
Collaborator

Summary

Optimize the Base skill reference set so the skill routes by task and keeps only high-value guidance for complex Base JSON/DSL workflows. This removes command-manual style reference pages and moves concise usage guidance into command tips and the main skill routing document.

Changes

  • Compress skills/lark-base/SKILL.md into routing, boundaries, token/link handling, identity fallback, query/write rules, and retained reference guidance.
  • Delete low-density per-command Base reference files while retaining complex references for field JSON, CellValue, data-query, view filters, forms, dashboard blocks, workflow schema, and role config.
  • Add concise tips to Base shortcuts for simple commands whose references were removed, and update JSON error guidance to point agents at complex references only when needed.
  • Update retained references to avoid links to deleted command pages and to teach read-state/modify-shape workflows instead of telling agents to inspect --help.

Test Plan

  • Unit tests pass: go test ./shortcuts/base
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected: checked lark-cli drive +search --help for the Base title search example and scanned retained Base docs for deleted-reference links / low-value --help prompts.

Related Issues

  • None

Summary by CodeRabbit

  • New Features

    • Added built‑in CLI tips for many Base commands (examples, usage guidance, limits, and explicit high‑risk confirmation hints).
  • Documentation

    • Clarified flag/help text (pagination ranges, defaults, enums, JSON examples).
    • Consolidated/reorganized many reference pages; moved concrete examples into CLI tips and removed or condensed numerous long reference docs.
  • Tests

    • Added/updated tests to verify high‑risk tips and tightened JSON/help error messages.

@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown

Review Change Stack

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

Adds a package high-risk tip constant, updates json-help wording and related tests, attaches or edits Tips and flag descriptions across many Base shortcuts, and rewrites/cleans SKILL.md plus many lark-base reference Markdown files.

Changes

Base CLI tips & docs consolidation

Layer / File(s) Summary
All changes (shortcut Tips, helpers, tests, docs)
shortcuts/base/*, skills/lark-base/*, skill-template/domains/base.md
Adds package constant baseHighRiskYesTip, updates jsonInputTip wording and JSON-related tests, attaches/edits Tips arrays and flag descriptions across Base shortcuts (pagination ranges, defaults, JSON examples), and rewrites/condenses SKILL.md and many reference docs (removals/simplifications and some cross-reference adjustments).

Estimated code review effort: 🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Suggested reviewers

  • kongenpei
  • zhouyue-bytedance

"I'm a rabbit with a tiny pen,
I hopped through Tips and docs again,
One shared --yes, clearer flags, help in place,
SKILL trimmed down, and tests embrace.
Hop on — read first, then run the race!"

✨ 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 and usage tips.

@github-actions github-actions Bot added domain/base PR touches the base domain size/XL Architecture-level or global-impact change labels May 29, 2026
@codecov

codecov Bot commented May 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 69.22%. Comparing base (0e6274d) to head (63b61f2).
⚠️ Report is 14 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1171      +/-   ##
==========================================
+ Coverage   68.92%   69.22%   +0.29%     
==========================================
  Files         629      634       +5     
  Lines       58762    59555     +793     
==========================================
+ Hits        40503    41224     +721     
- Misses      14952    15012      +60     
- Partials     3307     3319      +12     

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

@zgz2048 zgz2048 force-pushed the codex/base-skill-reference-optimization branch 6 times, most recently from 5be573d to 57212ea Compare May 29, 2026 08:51
@zgz2048 zgz2048 marked this pull request as ready for review May 29, 2026 08:56
@github-actions

github-actions Bot commented May 29, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add zgz2048/cli#codex/base-skill-reference-optimization -y -g

@zgz2048 zgz2048 force-pushed the codex/base-skill-reference-optimization branch 3 times, most recently from 38a83f7 to 78519fb Compare June 1, 2026 12:44
kongenpei
kongenpei previously approved these changes Jun 1, 2026
Comment thread skills/lark-base/references/lark-base-form-detail.md
@zgz2048 zgz2048 dismissed stale reviews from zhouyue-bytedance and kongenpei via 36785a4 June 2, 2026 04:17
@zgz2048 zgz2048 force-pushed the codex/base-skill-reference-optimization branch 10 times, most recently from a8c5966 to a618b19 Compare June 2, 2026 07:54
@zgz2048 zgz2048 force-pushed the codex/base-skill-reference-optimization branch 10 times, most recently from bba005d to 914aa1f Compare June 2, 2026 08:49
@zgz2048 zgz2048 force-pushed the codex/base-skill-reference-optimization branch from 914aa1f to 63b61f2 Compare June 2, 2026 08:52
@zgz2048 zgz2048 merged commit e57d97f into larksuite:main Jun 2, 2026
18 checks passed
@liangshuo-1 liangshuo-1 mentioned this pull request Jun 2, 2026
1 task
tuxedomm pushed a commit to zhumiaoxin/cli that referenced this pull request Jun 6, 2026
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 size/XL Architecture-level or global-impact change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants