docs: optimize base skill references#1171
Open
zgz2048 wants to merge 1 commit into
Open
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (136)
💤 Files with no reviewable changes (77)
📝 WalkthroughWalkthroughThis PR consolidates Base CLI shortcut guidance into built-in tips and centralized documentation by (1) introducing a shared high-risk command tip constant and applying it across 20+ write shortcuts, (2) clarifying flag descriptions for pagination and defaults across 16 shortcuts, (3) updating JSON validation error messages and their tests, (4) rewriting SKILL.md with a tighter execution contract and routing framework, and (5) removing 60+ individual command reference pages in favor of --help-based guidance and core documentation. ChangesShortcut Tips Infrastructure and High-Risk Commands
Documentation Consolidation and Skill Guide Rewrite
Estimated code review effort: 🎯 4 (Complex) | ⏱️ ~60 minutesPossibly related PRs
Suggested labels
Suggested reviewers
✨ Finishing Touches🧪 Generate unit tests (beta)
|
github-actions
Bot
added
domain/base
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1171 +/- ##
=======================================
Coverage 68.92% 68.92%
=======================================
Files 629 629
Lines 58762 58762
=======================================
Hits 40503 40503
Misses 14952 14952
Partials 3307 3307 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
zgz2048
force-pushed
the
codex/base-skill-reference-optimization
branch
5 times, most recently
from
ff761be to
5be573d
Compare
zgz2048
force-pushed
the
codex/base-skill-reference-optimization
branch
from
5be573d to
57212ea
Compare
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@57212eaaa7fc83a77cdddd76ce05d5485be9e4e8🧩 Skill updatenpx skills add zgz2048/cli#codex/base-skill-reference-optimization -y -g |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
skills/lark-base/SKILL.mdinto routing, boundaries, token/link handling, identity fallback, query/write rules, and retained reference guidance.--help.Test Plan
go test ./shortcuts/baselark-cli <domain> <command>flow works as expected: checkedlark-cli drive +search --helpfor the Base title search example and scanned retained Base docs for deleted-reference links / low-value--helpprompts.Related Issues
Summary by CodeRabbit
New Features
Documentation