Skip to content

docs(slides): use built-in --jq in cli examples and fix workflow link labels - #2286

Merged
R0bynZhu merged 2 commits into
mainfrom
apply-slides-cli-doc-tweaks
Aug 11, 2026
Merged

docs(slides): use built-in --jq in cli examples and fix workflow link labels#2286
R0bynZhu merged 2 commits into
mainfrom
apply-slides-cli-doc-tweaks

Conversation

@R0bynZhu

@R0bynZhu R0bynZhu commented Aug 11, 2026

Copy link
Copy Markdown
Collaborator

Small docs-only fixes to the lark-slides references/cli/ command references. No code changed.

Summary

Update 4 CLI command docs: replace the external | jq -r pipe in examples with lark-cli's built-in --jq flag, and fix stale workflow link labels. Applied from local edits in the internal mirror.

Changes

  • lark-slides-media-upload.md| jq -r '.data.file_token'--jq '.data.file_token'; drop a stray leading blank line.
  • lark-slides-replace-slide.md — same --jq swap; link label lark-slides-edit-workflows.mdslides_editing.md.
  • lark-slides-xml-presentation-slide-get.md — link label → slides_editing.md.
  • lark-slides-xml-presentation-slide-replace.md--jq swap; link label → slides_editing.md.

Why --jq: it's a built-in lark-cli flag (-q/--jq, added in #211) that filters JSON output in-process, so examples no longer depend on an external jq binary being installed and avoid stderr progress lines polluting $(...).

Summary by CodeRabbit

  • Documentation
    • Updated slide media, image upload, XML extraction, and revision lookup examples to use the built-in --jq option, eliminating the need for external JSON-processing commands.
    • Corrected workflow reference labels and standardized links to the slide editing workflow across related guides.
    • Improved command examples for more consistent, streamlined copying and execution.

@github-actions github-actions Bot added the size/M Single-domain feat or fix with limited business impact label Aug 11, 2026
@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 413a8072-3df0-43ea-b07d-fb8ba5733e7e

📥 Commits

Reviewing files that changed from the base of the PR and between c186ba5 and 3abd20a.

📒 Files selected for processing (3)
  • skills/lark-slides/references/cli/lark-slides-replace-slide.md
  • skills/lark-slides/references/cli/lark-slides-xml-presentation-slide-get.md
  • skills/lark-slides/references/workflow/slides_editing.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • skills/lark-slides/references/cli/lark-slides-xml-presentation-slide-get.md
  • skills/lark-slides/references/cli/lark-slides-replace-slide.md

📝 Walkthrough

Walkthrough

The Slides CLI documentation now uses built-in --jq extraction for tokens, revision IDs, and XML values. Related workflow links now display slides_editing.md.

Changes

Slides CLI documentation

Layer / File(s) Summary
Use built-in JSON extraction
skills/lark-slides/references/cli/*.md, skills/lark-slides/references/workflow/slides_editing.md
Examples use lark-cli --jq instead of external jq pipelines to extract file_token, revision_id, and XML-related values.
Update workflow references
skills/lark-slides/references/cli/*.md
Related workflow link labels now use slides_editing.md. The link targets remain unchanged.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

Suggested reviewers: liangshuo-1

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description check ✅ Passed The description clearly covers the scope and changes, but it omits the template's Test Plan and Related Issues sections.
Title check ✅ Passed The title clearly summarizes the main documentation changes: built-in --jq usage and corrected workflow link labels.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch apply-slides-cli-doc-tweaks

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.

@github-actions

github-actions Bot commented Aug 11, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#apply-slides-cli-doc-tweaks -y -g

@codecov

codecov Bot commented Aug 11, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.46%. Comparing base (d289566) to head (3abd20a).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2286      +/-   ##
==========================================
+ Coverage   76.44%   76.46%   +0.01%     
==========================================
  Files        1013     1013              
  Lines      111972   112034      +62     
==========================================
+ Hits        85601    85665      +64     
+ Misses      19860    19857       -3     
- Partials     6511     6512       +1     

☔ View full report in Codecov by Harness.
📢 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.

@R0bynZhu
R0bynZhu merged commit 169e30c into main Aug 11, 2026
42 of 57 checks passed
@R0bynZhu
R0bynZhu deleted the apply-slides-cli-doc-tweaks branch August 11, 2026 09:53
@liangshuo-1 liangshuo-1 mentioned this pull request Aug 11, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants