Skip to content

docs: clarify lark-doc content file paths#1477

Closed
ZEden0 wants to merge 1 commit into
larksuite:mainfrom
ZEden0:lark-doc-skill-content-path-docs
Closed

docs: clarify lark-doc content file paths#1477
ZEden0 wants to merge 1 commit into
larksuite:mainfrom
ZEden0:lark-doc-skill-content-path-docs

Conversation

@ZEden0

@ZEden0 ZEden0 commented Jun 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Clarify how the lark-doc skill should pass local files to --content.
The updated guidance tells agents to use cwd-relative @path values and to enter the file directory before referencing files provided as absolute paths.

Changes

  • Add a global lark-doc note for local --content @path handling
  • Add matching create and update shortcut guidance for cwd-relative file input
  • Replace the older @file.md wording in update examples with clearer local file input wording

Test Plan

  • git diff --check passed
  • Verified the final diff only updates lark-doc skill/reference docs
  • Manual validation: docs +create, docs +update, and docs +fetch passed with --content @./draft*.md for both bot and user identities

Related Issues

N/A

Summary by CodeRabbit

  • Documentation
    • Clarified local file input path handling: --content @path`` accepts only current working directory-relative paths (e.g., @./filename), rejecting absolute paths.
    • Added user guidance to change directory first when referencing files with absolute paths, then use @./filename syntax.

Document that --content @path must use cwd-relative paths, add create/update examples, and record blackbox validation evidence for local file input.

Spec source: active@4ecda2b4e5b97c4735a03f0cc3591dfe25ba4c2c543c91ec69d6448d04d3fbe9
@coderabbitai

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

Run ID: 8cf6495c-b326-45e1-98e6-af396db2e88f

📥 Commits

Reviewing files that changed from the base of the PR and between 297b2a2 and e940bdb.

📒 Files selected for processing (3)
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-create.md
  • skills/lark-doc/references/lark-doc-update.md

📝 Walkthrough

Walkthrough

Three documentation files in skills/lark-doc are updated to clarify that --content @path`` only accepts CWD-relative paths, disallows absolute or escaping paths, and recommends users cd to the file directory and use `@./filename`. The update in `lark-doc-update.md` also rewrites multi-line Markdown guidance to recommend heredoc or local file input.

Changes

lark-doc --content @path path restriction clarification

Layer / File(s) Summary
--content @path`` CWD restriction across skill rules and reference pages
skills/lark-doc/SKILL.md, `skills/lark-doc/references/lark-doc-create.md`, `skills/lark-doc/references/lark-doc-update.md`
Adds the CWD-relative path constraint to the global formatting rules in SKILL.md, and adds matching clarification notes to both lark-doc-create.md and lark-doc-update.md; also rewords multi-line Markdown content guidance in lark-doc-update.md to recommend heredoc or local file input.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • larksuite/cli#1375: Adds the same --content @path`` CWD-only restriction warning and cd + `@./filename` guidance to `skills/lark-doc` documentation.
  • larksuite/cli#1319: Adds the equivalent CWD-relative path restriction for @... file inputs in the shared lark-shared skill rules.

Suggested labels

size/M, domain/ccm

Suggested reviewers

  • fangshuyu-768
  • SunPeiYang996

Poem

🐰 Hoppity-hop, no wandering astray,
Paths must stay close to the CWD today!
No slashes to root, no escaping the nest,
Just cd to your folder — that's simply the best.
@./filename keeps all the docs tidy and bright! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change: clarifying documentation about content file paths in lark-doc, which is the primary purpose across all three modified files.
Description check ✅ Passed The description follows the template structure with all required sections (Summary, Changes, Test Plan, Related Issues) completed with relevant details about the documentation updates and validation performed.
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

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/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jun 16, 2026
@codecov

codecov Bot commented Jun 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.38%. Comparing base (72c2947) to head (e940bdb).
⚠️ Report is 7 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1477      +/-   ##
==========================================
+ Coverage   73.35%   73.38%   +0.02%     
==========================================
  Files         750      750              
  Lines       69264    69355      +91     
==========================================
+ Hits        50811    50897      +86     
+ Misses      14713    14709       -4     
- Partials     3740     3749       +9     

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

@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add ZEden0/cli#lark-doc-skill-content-path-docs -y -g

@ZEden0 ZEden0 closed this Jun 16, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant