Skip to content

fix(base): guide complete dashboard data recovery - #2144

Open
wanghm25 wants to merge 2 commits into
larksuite:mainfrom
wanghm25:codex/docs-dashboard-complete-read-fallback
Open

fix(base): guide complete dashboard data recovery#2144
wanghm25 wants to merge 2 commits into
larksuite:mainfrom
wanghm25:codex/docs-dashboard-complete-read-fallback

Conversation

@wanghm25

@wanghm25 wanghm25 commented Aug 2, 2026

Copy link
Copy Markdown
Contributor

Summary

Prevent complete dashboard reads from silently omitting text blocks or chart types that do not support the computed-data endpoint.

Changes

  • Route text blocks to dashboard block metadata, where their content is available in data_config.text.
  • Guide unsupported computed-data chart types to reconstruct results with +data-query from the block's real table, dimensions, measures, and filters.
  • Document the per-block recovery flow in the Base skill and dashboard reference.
  • Extend dashboard help contract assertions for the new recovery guidance.

Test Plan

  • Unit tests pass (not run locally; GitHub CI will validate them)
  • git diff --check
  • gofmt -d reports no formatting changes for the modified Go files
  • Manual local verification confirms the lark-cli base flow works as expected

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Improved guidance for retrieving complete dashboards, including text blocks, chart data, and block metadata.
    • Clarified pagination steps for listing all dashboard components.
    • Added instructions for handling chart types without direct data retrieval.
    • Updated guidance to preserve text content and clearly report limitations when components cannot be fully reconstructed.

@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 Aug 2, 2026
@coderabbitai

coderabbitai Bot commented Aug 2, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 527e1d05-0c15-4292-97cd-d874d2a2cee7

📥 Commits

Reviewing files that changed from the base of the PR and between 3288790 and 913a8f3.

📒 Files selected for processing (3)
  • shortcuts/base/base_shortcuts_test.go
  • shortcuts/base/dashboard_block_list.go
  • skills/lark-base/references/lark-base-dashboard.md
🚧 Files skipped from review as they are similar to previous changes (2)
  • shortcuts/base/base_shortcuts_test.go
  • skills/lark-base/references/lark-base-dashboard.md

📝 Walkthrough

Walkthrough

Dashboard retrieval guidance now covers paginated block enumeration, text block content, complete dashboard exports, and unsupported computed data. Command tips, tests, and Lark Base skill references describe the required fallback flow.

Changes

Dashboard read guidance

Layer / File(s) Summary
Dashboard command tips and tests
shortcuts/base/dashboard_block_list.go, shortcuts/base/dashboard_block_get.go, shortcuts/base/dashboard_block_get_data.go, shortcuts/base/base_shortcuts_test.go
Tips and expectations cover pagination with --page-size 100, text content in data_config.text, complete exports, unsupported computed data, and the +data-query fallback.
Complete dashboard read flow
skills/lark-base/SKILL.md, skills/lark-base/references/lark-base-dashboard.md
Guidance requires enumerating all blocks, reading text content, separating chart data from metadata, and reporting limits when unsupported data cannot be rebuilt.

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

Suggested reviewers: zgz2048

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the fix for complete dashboard data recovery, matching the main changes.
Description check ✅ Passed The description includes all required sections, summarizes the change, lists changes, records validation, and identifies no related issues.
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

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

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.

1 participant