docs: optimize base workflow guidance

[xiaomi-bytedance]

Changes

• Add a concise Base workflow quick guide for common read/update paths.
• Clarify when agents should read the full workflow guide/schema versus staying on the quick path.
• Tighten workflow command tips around full-update semantics and schema usage.

Related Issues

• None.

Test Plan

• git diff --check
• go test -p 1 ./shortcuts/base

Summary by CodeRabbit

• Documentation
  • Added a quick-reference guide for common workflow operations and when to consult detailed schema documentation.
  • Updated workflow guidance to prioritize the quick guide for routine tasks and clarify full-schema requirements for step changes.
  • Clarified supported trigger types, including alternatives for deletion-related notifications.
  • Added guidance to avoid inventing unsupported workflow step fields or event types.
• Usability
  • Improved workflow create, view, and update instructions for clearer, safer operation.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 41a1282e-4de9-46eb-a929-6767ffc57326

📥 Commits

Reviewing files that changed from the base of the PR and between 543e81b and 63748cc.

📒 Files selected for processing (2)

• skills/lark-base/SKILL.md
• skills/lark-base/references/lark-base-workflow-quick.md

💤 Files with no reviewable changes (1)

• skills/lark-base/references/lark-base-workflow-quick.md

✅ Files skipped from review due to trivial changes (1)

• skills/lark-base/SKILL.md

---

📝 Walkthrough

Walkthrough

This PR adds a Base Workflow quick-reference document and updates shortcut guidance, skill routing, trigger documentation, and related test expectations to use quick-guide-first workflow instructions.

Changes

Workflow quick guide documentation and shortcut tip updates

Layer / File(s)	Summary
New workflow quick guide reference document skills/lark-base/references/lark-base-workflow-quick.md	Adds routing rules, short-path guidance, unsupported trigger boundaries, step data keys, prerequisite checks, schema pointers, and workflow construction constraints.
Shortcut guidance and matching tests shortcuts/base/workflow_get.go, shortcuts/base/workflow_create.go, shortcuts/base/workflow_update.go, shortcuts/base/base_shortcuts_test.go	Updates Tips and the --json description to reference the quick guide, separates creation guidance, and updates expected help text.
Skill routing integration skills/lark-base/SKILL.md	Changes workflow routing to a quick-guide-first decision flow and adds the quick guide to retained references.
Trigger selection documentation skills/lark-base/references/lark-base-workflow-guide.md, skills/lark-base/references/lark-base-workflow-schema.md	Clarifies AddRecordTrigger usage, documents the absence of DeleteRecordTrigger, and describes field-change alternatives for physical-delete requirements.

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

Possibly related PRs

• larksuite/cli#345: Updates workflow update guidance, including the --json description.
• larksuite/cli#374: Updates workflow routing guidance in skills/lark-base/SKILL.md.

Suggested labels: documentation

Suggested reviewers: kongenpei, zhouyue-bytedance, zgz2048

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title is concise and accurately reflects the PR’s main focus on improving Base workflow documentation.
Description check	✅ Passed	The description covers Changes, Test Plan, and Related Issues, but it is missing the required Summary section.
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.

✨ 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

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[CLAassistant]

All committers have signed the CLA.

[github-actions]

🚀 PR Preview Install Guide

🧰 CLI update

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

🧩 Skill update

npx skills add xiaomi-bytedance/cli#patch-1 -y -g