Skip to content

docs(base): harden dashboard multi-block read guidance - #2122

Open
wanghm25 wants to merge 3 commits into
larksuite:mainfrom
wanghm25:docs/dashboard-multi-block-read-guidance
Open

docs(base): harden dashboard multi-block read guidance#2122
wanghm25 wants to merge 3 commits into
larksuite:mainfrom
wanghm25:docs/dashboard-multi-block-read-guidance

Conversation

@wanghm25

@wanghm25 wanghm25 commented Jul 30, 2026

Copy link
Copy Markdown

Summary

Ports the dashboard documentation changes from #2117 onto a branch in my fork and adds focused pagination and strict failure-handling fixes.

Changes

The commits remain independently scoped:

  1. Patch-equivalent port of feat(base): clarify dashboard multi-block read pattern and arrange constraints #2117
  2. Pagination fix
  3. Strict failure-handling fix

Test Plan

  • git diff --check
  • Confirmed this is a documentation-only change with no runtime code or dependency changes.
  • Confirmed the three commits remain independently scoped.

Related Issues

This PR does not close or modify #2117; the original PR remains open unchanged.

Summary by CodeRabbit

  • Documentation
    • Clarified dashboard guidance for reading one or multiple component calculation results.
    • Added pagination instructions for retrieving all dashboard components.
    • Documented safer serial processing for multiple component results, including skipping text-only components.
    • Clarified dashboard layout limitations, including the lack of precise placement and sizing controls.
    • Updated validation guidance for successful dashboard creation and layout rearrangement workflows.

…nstraints

- SKILL.md: update routing table to say "一个或多个图表计算结果" for +dashboard-block-get-data; add three new Dashboard guidance bullets covering arrange precision limits, creation verification shortcut, and multi-block serial read pattern
- lark-base-dashboard-block-get-data.md: add multi-block serial loop example with safety note that IDs must come verbatim from +dashboard-block-list
- lark-base-dashboard.md: tighten arrange caution block (x/y/w/h wording, two new caution bullets); fix verification guideline to not call +dashboard-block-get-data just to confirm creation; add multi-block read hint after scenario 5
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updates Lark Base dashboard guidance for shortcut limitations, creation verification, layout rearrangement, and serial retrieval of multiple component calculation results.

Changes

Dashboard documentation

Layer / File(s) Summary
Dashboard routing guidance
skills/lark-base/SKILL.md
Clarifies that single- and multi-component calculation results use +dashboard-block-get-data, and adds rules for layout limitations, write confirmation, and multi-component retrieval.
Dashboard creation and layout workflows
skills/lark-base/references/lark-base-dashboard.md
Updates +dashboard-arrange limitations, creation verification, existing-dashboard rearrangement cautions, and single-call stopping behavior.
Multi-component result retrieval
skills/lark-base/references/lark-base-dashboard-block-get-data.md, skills/lark-base/references/lark-base-dashboard.md
Documents paginated block listing, validated block IDs, serial reads in one shell call, and skipping text components without calculation results.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

  • larksuite/cli#2117: Updates the same dashboard documentation flow, including serial multi-block retrieval and layout constraints.
  • larksuite/cli#1067: Implements and tests the +dashboard-block-get-data shortcut referenced by these documentation updates.
  • larksuite/cli#374: Updates the same Base dashboard workflow and computed-result routing guidance.

Suggested reviewers: zhouyue-bytedance

🚥 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 is concise and accurately reflects the main change: tighter guidance for dashboard multi-block reads.
Description check ✅ Passed The description covers Summary, Changes, Test Plan, and Related Issues, matching the template closely.
✨ 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

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

@github-actions github-actions Bot added domain/base PR touches the base domain size/M Single-domain feat or fix with limited business impact labels Jul 30, 2026
@CLAassistant

CLAassistant commented Jul 30, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/lark-base/references/lark-base-dashboard-block-get-data.md`:
- Line 66: Update the --dashboard-id example in the dashboard data command to
use a dashboard-shaped placeholder such as dshxxxxxxxx instead of the
block-shaped blkxxxxxxxx, while leaving the separate --block-id example
unchanged.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: ac87edf5-1223-48ac-830c-d3b90d4feb56

📥 Commits

Reviewing files that changed from the base of the PR and between 4a16139 and 6002142.

📒 Files selected for processing (3)
  • skills/lark-base/SKILL.md
  • skills/lark-base/references/lark-base-dashboard-block-get-data.md
  • skills/lark-base/references/lark-base-dashboard.md

Comment thread skills/lark-base/references/lark-base-dashboard-block-get-data.md
@github-actions

github-actions Bot commented Jul 31, 2026

Copy link
Copy Markdown

PR Quality Summary

CI did not complete successfully. Use the failed check links below to decide whether this PR needs a code change or a rerun.

CI status

  • Workflow conclusion: cancelled.

@github-actions

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@600214240c78e83c10475a92b5224fb2c983ff5c

🧩 Skill update

npx skills add wanghm25/cli#docs/dashboard-multi-block-read-guidance -y -g

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/base PR touches the base 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.

3 participants