Skip to content

docs: improve lark-markdown skill guidance#1279

Merged
fangshuyu-768 merged 1 commit into
mainfrom
codex/optimize-lark-markdown-skill
Jun 5, 2026
Merged

docs: improve lark-markdown skill guidance#1279
fangshuyu-768 merged 1 commit into
mainfrom
codex/optimize-lark-markdown-skill

Conversation

@fangshuyu-768

@fangshuyu-768 fangshuyu-768 commented Jun 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • add explicit in-scope and out-of-scope boundaries to the lark-markdown skill description so routing is clearer for Markdown versus broader Drive and online-document workflows
  • clarify markdown identity guidance by prioritizing --as user, noting when --as bot can still apply, and pointing first-time user access to lark-cli auth login
  • add regex good/bad examples for markdown +patch and explain why empty final content is rejected
  • set the skill version to 1.2.1

Context

This updates the lark-markdown business-domain skill based on the referenced review points, covering routing boundaries, identity guidance, example completeness, and rationale for constraints.

Testing

  • git diff --check

Summary by CodeRabbit

Release Notes

  • Documentation
    • Updated skill documentation (v1.2.0 → v1.2.1) with enhanced execution identity guidance (--as user vs --as bot)
    • Added prerequisite: run lark-cli auth login before first user access
    • Clarified markdown patch constraints: replaced content must be non-empty, file paths must be local .md
    • Added regex escaping guidance with BAD/GOOD pattern examples for special characters

@coderabbitai

coderabbitai Bot commented Jun 5, 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

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: e8ea1edc-0b8c-4513-9113-a32a8e7f103d

📥 Commits

Reviewing files that changed from the base of the PR and between cc95581 and 0e0df10.

📒 Files selected for processing (2)
  • skills/lark-markdown/SKILL.md
  • skills/lark-markdown/references/lark-markdown-patch.md
✅ Files skipped from review due to trivial changes (2)
  • skills/lark-markdown/references/lark-markdown-patch.md
  • skills/lark-markdown/SKILL.md

📝 Walkthrough

Walkthrough

Bumps lark-markdown skill version to 1.2.1, adds identity/authentication notes for markdown commands, and expands markdown +patch docs to require non-empty replacements, restrict --file to local .md paths, and add RE2 --pattern escaping examples and Good/Bad patterns.

Changes

lark-markdown Skill Documentation

Layer / File(s) Summary
Version and authentication prerequisites
skills/lark-markdown/SKILL.md
Skill metadata version updated; adds identity selection note (--as user default; use --as bot for automation) and requires lark-cli auth login before first user access.
markdown +patch constraints and reference examples
skills/lark-markdown/SKILL.md, skills/lark-markdown/references/lark-markdown-patch.md
markdown +patch docs now state replaced Markdown must be non-empty (CLI errors and no upload if empty), --file must be a local .md path, and RE2 --pattern escaping guidance with BAD/GOOD examples and behavior for zero matches is added.

🎯 2 (Simple) | ⏱️ ~10 minutes

Suggested labels

domain/ccm

Suggested reviewers

  • wittam-01

"🐇 I hopped through docs to tidy each line,
Version bumped up, auth steps align.
Escape your patterns, keep files local and bright,
No empty patches — uploads done right.
A tiny joyful hop, and the docs feel fine."

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The PR description covers the Summary, Context, and Testing sections; however, it omits the structured Changes list and Test Plan checklist from the template. Add a Changes section listing the main updates and include the Test Plan checklist (even if only noting git diff --check) for consistency with the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: improve lark-markdown skill guidance' is clear, concise, and directly summarizes the main documentation improvements to the lark-markdown skill.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/optimize-lark-markdown-skill

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 the size/M Single-domain feat or fix with limited business impact label Jun 5, 2026
@github-actions

github-actions Bot commented Jun 5, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@0e0df1009438568bafb67e9b8081c30a0c2af6bf

🧩 Skill update

npx skills add larksuite/cli#codex/optimize-lark-markdown-skill -y -g

@codecov

codecov Bot commented Jun 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.17%. Comparing base (a4a4bd6) to head (0e0df10).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1279      +/-   ##
==========================================
- Coverage   70.18%   70.17%   -0.01%     
==========================================
  Files         671      671              
  Lines       65240    65329      +89     
==========================================
+ Hits        45786    45845      +59     
- Misses      15783    15795      +12     
- Partials     3671     3689      +18     

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

wittam-01
wittam-01 previously approved these changes Jun 5, 2026
@fangshuyu-768
fangshuyu-768 force-pushed the codex/optimize-lark-markdown-skill branch 2 times, most recently from 7e120d3 to cc95581 Compare June 5, 2026 04:20
@fangshuyu-768
fangshuyu-768 force-pushed the codex/optimize-lark-markdown-skill branch from cc95581 to 0e0df10 Compare June 5, 2026 04:23
@fangshuyu-768
fangshuyu-768 merged commit 2f4e2c3 into main Jun 5, 2026
23 checks passed
@fangshuyu-768
fangshuyu-768 deleted the codex/optimize-lark-markdown-skill branch June 5, 2026 04:34
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

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants