Skip to content

docs(slides): generalize whole-page validation guidance - #2255

Closed
tianyouskrrr wants to merge 1 commit into
mainfrom
fix/slides-generalize-validation-guidance
Closed

docs(slides): generalize whole-page validation guidance#2255
tianyouskrrr wants to merge 1 commit into
mainfrom
fix/slides-generalize-validation-guidance

Conversation

@tianyouskrrr

@tianyouskrrr tianyouskrrr commented Aug 10, 2026

Copy link
Copy Markdown
Collaborator

Summary

Follow-up to #2227's restoration of the +update-slide route. The whole-page validation gate is a command-agnostic quality gate keyed on the "whole-page write-back" action, not on whichever shortcut currently performs it. #2227 hardcoded +update-slide into the validation CRITICAL in SKILL.md and the migrated workflow/validation-xml.md, reintroducing the special-casing that #2143 avoided. This PR generalizes the wording back to the behavior so the gate stays bound to the action and survives future default-command rollouts without further doc edits.

Changes

  • skills/lark-slides/SKILL.md: drop the +update-slide special-case from the validation CRITICAL, keying it on whole-page write-back instead.
  • skills/lark-slides/references/workflow/validation-xml.md: apply the same generalization.
  • The lint CRITICAL's explicit command list is left unchanged — it has enumerated the whole-page XML entry points since the replace-pages era, so it is not a special-case introduced by fix(slides): restore update-slide skill guidance #2227.

Test Plan

  • make quality-gate passes locally (EXIT=0), no REJECT; only a pre-existing skill_critical_noise WARNING unrelated to this PR remains.
  • Documentation only; no behavior change.

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified that explicit post-creation validation is required after creating slides, making major rewrites, or writing back an entire page.
    • Updated validation guidance to apply broadly to full-page changes rather than a specific update operation.

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

coderabbitai Bot commented Aug 10, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The change updates Lark Slides documentation so explicit validation applies after creation, major rewrites, and full-page write-backs. It removes the specific requirement to validate after every slides +update-slide operation.

Changes

Slides documentation

Layer / File(s) Summary
Validation trigger guidance
skills/lark-slides/SKILL.md, skills/lark-slides/references/workflow/validation-xml.md
The validation requirement now covers creation, major rewrites, and full-page write-backs. References to every slides +update-slide operation were removed.

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

Possibly related PRs

  • larksuite/cli#2143: Introduced the slides +update-slide behavior referenced by the updated validation guidance.
  • larksuite/cli#2187: Modified the same slide skill and workflow guidance.
  • larksuite/cli#2207: Introduced related post-edit validation guidance in validation-xml.md.

Suggested labels: documentation

Suggested reviewers: liangshuo-1

🚥 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.
Title check ✅ Passed The title clearly and concisely describes the main documentation change: generalizing whole-page validation guidance.
Description check ✅ Passed The description follows the required template and clearly explains the scope, changes, verification, and related issues.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/slides-generalize-validation-guidance

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.

@tianyouskrrr tianyouskrrr self-assigned this Aug 10, 2026
@github-actions

github-actions Bot commented Aug 10, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add larksuite/cli#fix/slides-generalize-validation-guidance -y -g

@codecov

codecov Bot commented Aug 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.36%. Comparing base (2016120) to head (3761a23).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2255   +/-   ##
=======================================
  Coverage   76.36%   76.36%           
=======================================
  Files        1011     1011           
  Lines      111269   111269           
=======================================
  Hits        84970    84970           
  Misses      19815    19815           
  Partials     6484     6484           

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

Generalize the whole-page validation gate so it is keyed on the action,
not on a single shortcut name.

The validation CRITICAL in SKILL.md and the migrated
workflow/validation-xml.md are command-agnostic quality gates: they
apply to the "whole-page write-back" action regardless of which shortcut
performs it. #2227 hardcoded +update-slide into them, reintroducing the
special-casing that #2143 avoided. Rephrase back to the behavior
("整页写回") so the gate stays bound to the action rather than the
currently-routed command.

The lint CRITICAL keeps its explicit command list unchanged — it has
enumerated the whole-page XML entry points since the replace-pages era,
so it is not a special-case introduced by #2227.

The /wiki/ example URL and the +replace-slide single-line --parts JSON
introduced by #2227 are left as-is: the quality-gate harness executes
skill examples under --dry-run, so the placeholder <wiki_url> fails the
wiki token length check and a multi-line single-quoted --parts is not
parseable. Both current forms are required to pass the gate.

Documentation only; no behavior change.
@tianyouskrrr
tianyouskrrr force-pushed the fix/slides-generalize-validation-guidance branch from bb2a053 to 3761a23 Compare August 10, 2026 07:29
@tianyouskrrr tianyouskrrr changed the title docs(slides): generalize validation guidance and revert unrelated #2227 changes docs(slides): generalize whole-page validation guidance Aug 10, 2026
tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
@tianyouskrrr

Copy link
Copy Markdown
Collaborator Author

Folded into #2225. The whole-page validation-gating generalization here (SKILL.md and workflow/validation-xml.md — "整页写回后" instead of hardcoding +update-slide) is now part of #2225 (commit 1bf712d), alongside pointing page_replace/slide_replace recovery at +update-slide and completing the #2227 +replace-pages doc deprecation. Closing to avoid duplication.

tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
tianyouskrrr added a commit that referenced this pull request Aug 10, 2026
Normalize deterministic +replace-slide part aliases (replace→block_replace,
target_id→block_id, and payload field folding), and reject semantically
different actions up front.

Point whole-page actions at +update-slide now that it is GA:
- page_replace / slide_replace recovery guidance and the reference error
  table now direct callers to `slides +update-slide` (in-place whole-page
  rewrite) instead of the deprecated +replace-pages.
- drop the +replace-pages reference doc, completing the #2227 deprecation
  (the command stays; its deprecation signal is carried by --help and the
  output JSON `deprecated` field).

Generalize whole-page validation gating to the behavior rather than a
command name (SKILL.md, workflow/validation-xml.md): "整页写回后" instead of
"每次通过 +update-slide 整页写回后". Folds in PR #2255.
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.

1 participant