docs(slides): generalize whole-page validation guidance - #2255
docs(slides): generalize whole-page validation guidance#2255tianyouskrrr wants to merge 1 commit into
Conversation
📝 WalkthroughWalkthroughThe 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 ChangesSlides documentation
Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
Suggested labels: Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches 💡 1🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@3761a232dbdb7c749b829372e47a2d66c5d46802🧩 Skill updatenpx skills add larksuite/cli#fix/slides-generalize-validation-guidance -y -g |
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
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.
bb2a053 to
3761a23
Compare
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.
|
Folded into #2225. The whole-page validation-gating generalization here (SKILL.md and workflow/validation-xml.md — "整页写回后" instead of hardcoding |
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.
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.
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.
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.
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.
Summary
Follow-up to #2227's restoration of the
+update-slideroute. 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-slideinto the validation CRITICAL inSKILL.mdand the migratedworkflow/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-slidespecial-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.Test Plan
make quality-gatepasses locally (EXIT=0), no REJECT; only a pre-existingskill_critical_noiseWARNING unrelated to this PR remains.Related Issues
Summary by CodeRabbit