Skip to content

docs: tighten doc creation validation workflow#1759

Merged
fangshuyu-768 merged 1 commit into
mainfrom
docs-skill-avoid-duplicate-short-title
Jul 6, 2026
Merged

docs: tighten doc creation validation workflow#1759
fangshuyu-768 merged 1 commit into
mainfrom
docs-skill-avoid-duplicate-short-title

Conversation

@fangshuyu-768

@fangshuyu-768 fangshuyu-768 commented Jul 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • clarify that short Markdown one-shot creation should avoid passing --title with an identical leading # heading
  • make word-count validation required when document creation requests include explicit length constraints
  • add a concise post-generation duplicate-title check that compares the document title with the first body title block and fixes repeats

Validation

  • git diff --check
  • node scripts/skill-format-check/index.js skills
  • zsh scripts/check-doc-tokens.sh skills fails on existing realistic-looking token examples in unrelated lark-wiki/lark-base/lark-approval reference docs

@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 Jul 6, 2026
@coderabbitai

coderabbitai Bot commented Jul 6, 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
📝 Walkthrough

Walkthrough

Updates the lark-doc create workflow guide to define title ownership for short-document writes and to place duplicate-title checking before optional word-count validation.

Changes

Documentation update

Layer / File(s) Summary
Title source and validation rules
skills/lark-doc/references/style/lark-doc-create-workflow.md
Adds the rule that --title takes precedence for short document writes, avoids repeating the same title in the body’s opening # heading, and extends专项校验 to check title source before optional word-count validation.

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

Possibly related PRs

  • larksuite/cli#1474: Both PRs adjust lark-doc create-workflow guidance around title formatting and duplicate title handling.
  • larksuite/cli#1701: Modifies the same workflow document and closely related title-handling rules.

Suggested reviewers: SunPeiYang996, caojie0621

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title is clear and broadly matches the docs change around stricter document creation validation and title handling.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-skill-avoid-duplicate-short-title

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.

@codecov

codecov Bot commented Jul 6, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.42%. Comparing base (1ba4f39) to head (7cc20b2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1759   +/-   ##
=======================================
  Coverage   74.42%   74.42%           
=======================================
  Files         854      854           
  Lines       88477    88477           
=======================================
  Hits        65852    65852           
  Misses      17555    17555           
  Partials     5070     5070           

☔ 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

github-actions Bot commented Jul 6, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#docs-skill-avoid-duplicate-short-title -y -g

@fangshuyu-768 fangshuyu-768 force-pushed the docs-skill-avoid-duplicate-short-title branch 7 times, most recently from c57d491 to 69c2a56 Compare July 6, 2026 06:42
@fangshuyu-768 fangshuyu-768 changed the title docs: clarify short markdown document title handling docs: clarify doc creation validation Jul 6, 2026
@fangshuyu-768 fangshuyu-768 force-pushed the docs-skill-avoid-duplicate-short-title branch from 69c2a56 to 7cc20b2 Compare July 6, 2026 06:44
@fangshuyu-768 fangshuyu-768 changed the title docs: clarify doc creation validation docs: tighten doc creation validation workflow Jul 6, 2026
@fangshuyu-768 fangshuyu-768 merged commit ee46e22 into main Jul 6, 2026
58 of 62 checks passed
@fangshuyu-768 fangshuyu-768 deleted the docs-skill-avoid-duplicate-short-title branch July 6, 2026 09:07
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.

2 participants