chore(docs): hide docs api-version compatibility flag#1580
Merged
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:
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 (33)
✅ Files skipped from review due to trivial changes (17)
🚧 Files skipped from review as they are similar to previous changes (13)
📝 WalkthroughWalkthroughThe PR removes explicit ChangesDocs api-version cleanup
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
github-actions
Bot
added
domain/ccm
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1580 +/- ##
==========================================
- Coverage 74.66% 74.66% -0.01%
==========================================
Files 804 804
Lines 81036 81032 -4
==========================================
- Hits 60505 60501 -4
Misses 16029 16029
Partials 4502 4502 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
SunPeiYang996
force-pushed
the
codex/drop-doc-api-version
branch
4 times, most recently
from
237c647 to
7e20181
Compare
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@fc7648e5e97bb7b77617ff1dc84474895b940496🧩 Skill updatenpx skills add larksuite/cli#codex/drop-doc-api-version -y -g |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 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-drive/references/lark-drive-add-comment.md`:
- Around line 158-162: The local comment example is missing the required
document input for block-id retrieval, so update the `--block-id` description in
the markdown to use the same complete `docs +fetch --doc <TOKEN> --detail
with-ids` form already shown below. Keep the wording consistent by ensuring the
`--block-id` guidance and the “局部评论需要先获取 block ID” step both reference the full
command with `--doc <TOKEN>`.
In `@skills/lark-workflow-meeting-summary/SKILL.md`:
- Around line 105-107: The `lark-cli docs +create` example in `SKILL.md` still
puts the document title inside `--content` instead of using the Markdown title
flag. Update the create example to follow the `lark-doc-create` guidance by
passing the title through `--title`, and keep `--content` for the body only; the
`docs +update` append example can remain as-is.
🪄 Autofix (Beta)
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
Run ID: ee0afe3b-d964-47ae-8c24-371685c19036
📒 Files selected for processing (34)
README.mdREADME.zh.mdshortcuts/doc/docs_create_test.goshortcuts/doc/docs_fetch_v2_test.goshortcuts/doc/docs_update_test.goshortcuts/doc/v2_only.goshortcuts/doc/v2_only_test.goshortcuts/note/note_transcript.goshortcuts/note/note_transcript_test.goshortcuts/register_test.goskill-template/domains/doc.mdskill-template/domains/drive.mdskills/lark-doc/SKILL.mdskills/lark-doc/references/lark-doc-create.mdskills/lark-doc/references/lark-doc-fetch.mdskills/lark-doc/references/lark-doc-md.mdskills/lark-doc/references/lark-doc-media-insert.mdskills/lark-doc/references/lark-doc-update.mdskills/lark-doc/references/lark-doc-whiteboard.mdskills/lark-doc/references/style/lark-doc-create-workflow.mdskills/lark-doc/references/style/lark-doc-update-workflow.mdskills/lark-drive/SKILL.mdskills/lark-drive/references/lark-drive-add-comment.mdskills/lark-drive/references/lark-drive-comment-location.mdskills/lark-drive/references/lark-drive-files-list.mdskills/lark-note/SKILL.mdskills/lark-note/references/lark-note-detail.mdskills/lark-note/references/lark-note-transcript.mdskills/lark-vc/SKILL.mdskills/lark-vc/references/lark-vc-notes.mdskills/lark-vc/references/vc-domain-boundaries.mdskills/lark-whiteboard/references/lark-whiteboard-workflow.mdskills/lark-workflow-meeting-summary/SKILL.mdtests/cli_e2e/doc/docs_dryrun_test.go
SunPeiYang996
force-pushed
the
codex/drop-doc-api-version
branch
3 times, most recently
from
aaf2255 to
a7f3efd
Compare
fangshuyu-768
previously approved these changes
Jun 26, 2026
fangshuyu-768
changed the title
SunPeiYang996
force-pushed
the
codex/drop-doc-api-version
branch
from
a7f3efd to
fc7648e
Compare
fangshuyu-768
approved these changes
Jun 26, 2026
liangshuo-1
approved these changes
Jun 26, 2026
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
3 participants
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
docs +create/+fetch/+update --api-versioncompatibility flag from shortcut help while continuing to accept it.--api-version v2guidance from lark-doc skills, related skill templates, README examples, and cross-skill references.Validation
/Users/bytedance/.agents/skills/remote-build-test/scripts/remote-run.sh --shell 'go test ./shortcuts ./shortcuts/doc ./shortcuts/note && go build -o lark-cli . && go test ./tests/cli_e2e/doc'\n-git diff --check\n-gofmt -l shortcuts/doc/v2_only.go shortcuts/doc/v2_only_test.go shortcuts/doc/docs_create_test.go shortcuts/doc/docs_fetch_v2_test.go shortcuts/doc/docs_update_test.go shortcuts/note/note_transcript.go shortcuts/note/note_transcript_test.go shortcuts/register_test.go tests/cli_e2e/doc/docs_dryrun_test.go\n\n## Notes\n\nquick_validate.pywas also tried against the touched skill directories, but the repo skills already use aversionfrontmatter field that the system validator rejects. No skill frontmatter format was changed in this PR.Summary by CodeRabbit
New Features
docs +fetch --dry-runworks with--api-version legacy.Documentation
--api-version v2fromdocs +create,docs +fetch, anddocs +updateexamples across README and skill/reference materials.Bug Fixes
--api-versionbehaves like a hidden, compatibility-only flag.