Skip to content

docs(lark-doc): restore style requirements#1579

Merged
fangshuyu-768 merged 1 commit into
mainfrom
codex/restore-lark-doc-style-required
Jun 25, 2026
Merged

docs(lark-doc): restore style requirements#1579
fangshuyu-768 merged 1 commit into
mainfrom
codex/restore-lark-doc-style-required

Conversation

@SunPeiYang996

@SunPeiYang996 SunPeiYang996 commented Jun 25, 2026

Copy link
Copy Markdown
Collaborator

Summary

Restore the lark-doc skill requirement to read lark-doc-style.md before document creation or editing, without reverting the softened style guidance content itself.

Changes

  • Add lark-doc-style.md back to the MUST READ lists for create/update content flows.
  • Ensure create/update workflow subagents receive both lark-doc-xml.md and lark-doc-style.md.
  • Leave lark-doc-style.md content unchanged from the current softened guidance.

Test Plan

  • git diff origin/main..HEAD --check
  • rg confirmed no remaining soft gating such as "only provide style when rich block" in the affected required-read paths
  • quick_validate.py is blocked by the existing version frontmatter key in this skill: Unexpected key(s) in SKILL.md frontmatter: version
  • Unit tests pass (not run; docs-only skill guidance change)
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected (not run; docs-only skill guidance change)

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified the required reading list for Lark document creation and editing workflows.
    • Standardized guidance so the style guide is now always included alongside XML and workflow references.
    • Removed conditional instructions, making the preparation steps more consistent and easier to follow.

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: d7317e67-3794-4b26-acc8-563e3a305a7d

📥 Commits

Reviewing files that changed from the base of the PR and between fe32a6e and 7465270.

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

📝 Walkthrough

Walkthrough

The PR updates lark-doc prerequisite guidance so create and update workflows explicitly require the XML, style, and workflow references. It also changes workflow docs so agent inputs always include lark-doc-style.md, removing prior conditional style guidance.

Changes

Lark doc guidance updates

Layer / File(s) Summary
Prerequisite lists
skills/lark-doc/SKILL.md, skills/lark-doc/references/lark-doc-create.md, skills/lark-doc/references/lark-doc-update.md
Create/edit prerequisite sections now explicitly require the XML, style, and workflow references, and remove the prior conditional style guidance.
Agent input contracts
skills/lark-doc/references/style/lark-doc-create-workflow.md, skills/lark-doc/references/style/lark-doc-update-workflow.md
The create and update workflow docs now always include lark-doc-style.md in the required agent input paths for spawn and content-rewrite steps.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

  • larksuite/cli#1463: Also changes skills/lark-doc guidance around whether lark-doc-style.md is conditional or required in prerequisite and agent-input paths.
  • larksuite/cli#1508: Touches the same skills/lark-doc create/update workflow guidance and style-reference requirements.

Suggested labels

documentation

Suggested reviewers

  • caojie0621

Poem

A bunny hops through docland bright,
With style guide tucked in snug and tight.
XML first, then paths align,
The workflow gleams; the crumbs are fine.
🐇📘

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch codex/restore-lark-doc-style-required

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 added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jun 25, 2026
Change-Id: I5c75a06ccac07586615c40db69b94d515f85d200
@SunPeiYang996 SunPeiYang996 force-pushed the codex/restore-lark-doc-style-required branch from 8aa037d to 7465270 Compare June 25, 2026 10:48
@codecov

codecov Bot commented Jun 25, 2026

Copy link
Copy Markdown

Codecov Report

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1579      +/-   ##
==========================================
+ Coverage   74.59%   74.94%   +0.34%     
==========================================
  Files         793      799       +6     
  Lines       79085    80813    +1728     
==========================================
+ Hits        58997    60566    +1569     
- Misses      15702    15797      +95     
- Partials     4386     4450      +64     

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

@fangshuyu-768 fangshuyu-768 marked this pull request as ready for review June 25, 2026 11:17
@fangshuyu-768 fangshuyu-768 merged commit 7346de3 into main Jun 25, 2026
24 of 25 checks passed
@fangshuyu-768 fangshuyu-768 deleted the codex/restore-lark-doc-style-required branch June 25, 2026 11:18
@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#codex/restore-lark-doc-style-required -y -g

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