Skip to content

docs: clarify native mindnote support boundary - #1569

Closed
xu91102 wants to merge 5 commits into
larksuite:mainfrom
xu91102:docs/mindnote-support-boundary
Closed

docs: clarify native mindnote support boundary#1569
xu91102 wants to merge 5 commits into
larksuite:mainfrom
xu91102:docs/mindnote-support-boundary

Conversation

@xu91102

@xu91102 xu91102 commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Summary

Clarify that native Mind Note URLs are not supported by the docs/whiteboard content shortcuts, and guide agents toward Drive-only operations for supported metadata, permission, and organization tasks.

Changes

  • Add a specific docs +fetch validation message for /mindnote/ URLs instead of the generic unsupported document URL text.
  • Cover the Mind Note URL case in parseDocumentRef tests.
  • Update lark-doc, lark-drive, and lark-whiteboard skill boundaries so agents do not route native Mind Note content requests to Docx or whiteboard flows.

Test Plan

  • GOPROXY=https://goproxy.cn,direct go test ./shortcuts/doc -run TestParseDocumentRef -count=1
  • GOPROXY=https://goproxy.cn,direct go test ./shortcuts/doc -count=1
  • git diff --check
  • Manual local verification confirms the lark-cli <domain> <command> flow works as expected (not run; this change is limited to parser validation text and skill documentation)

Related Issues

Summary by CodeRabbit

  • Bug Fixes

    • Correctly detects native Mind Note links (/mindnote/…) and stops them from being handled as whiteboard/Docx content.
    • Unsupported native Mind Note operations now return a clear validation error that specifies the relevant argument.
  • Documentation

    • Updated lark-doc, lark-drive, and lark-whiteboard scope docs to explicitly exclude native Mind Note content reading/node editing and clarify /mindnote/ routing.
  • Tests

    • Added coverage for /mindnote/… parsing, including verification of structured validation-error details.

@coderabbitai

coderabbitai Bot commented Jun 25, 2026

Copy link
Copy Markdown

Review Change Stack

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

  • @coderabbitai resume to resume automatic reviews.
  • @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

  • ▶️ Resume reviews
  • 🔍 Trigger review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: dc6e4acb-be42-49af-baf0-1c168672f03c

📥 Commits

Reviewing files that changed from the base of the PR and between ac30d8e and ce9124b.

📒 Files selected for processing (1)
  • skills/lark-drive/SKILL.md

📝 Walkthrough

Walkthrough

The PR rejects native /mindnote/ inputs in document parsing and updates Docs, Drive, and Whiteboard skill guidance to state that native Mind Note content and node editing are unsupported.

Changes

Mind Note routing and unsupported handling

Layer / File(s) Summary
Native Mind Note validation
shortcuts/doc/helpers.go, shortcuts/doc/helpers_test.go
parseDocumentRef now rejects /mindnote/ values with a validation error, and TestParseDocumentRef adds a table case plus structured error assertions for that input.
Drive skill scope and routing
skills/lark-drive/SKILL.md
The Drive skill description, quick decision guidance, URL/token table, and scope note now state that /mindnote/ maps to Drive-layer operations only and excludes content reading or node editing.
Docs and whiteboard scope notes
skills/lark-doc/SKILL.md, skills/lark-whiteboard/SKILL.md
The Docs and Whiteboard skill descriptions and scope bullets now say /mindnote/ is native Mind Note, not whiteboard, and that native Mind Note content or node editing is unsupported.

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

Possibly related PRs

  • larksuite/cli#1581: Also covers Mind Note (/mindnote/) routing guidance in lark-doc, with related native Mind Note handling clarifications.

Suggested labels: documentation

Suggested reviewers: liangshuo-1, SunPeiYang996, fangshuyu-768

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: clarifying native Mind Note support boundaries.
Description check ✅ Passed The description follows the template with Summary, Changes, Test Plan, and Related Issues filled in.
Linked Issues check ✅ Passed The PR addresses #1494 by clarifying unsupported native mindnote routing in docs, skills, errors, and tests.
Out of Scope Changes check ✅ Passed The changes stay within docs, routing validation, and tests; no unrelated code paths or features were added.
✨ 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/ccm PR touches the ccm domain size/L Large or sensitive change across domains or core paths labels Jun 25, 2026

@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 `@shortcuts/doc/helpers_test.go`:
- Around line 51-55: The negative case in the helpers test currently only checks
the validation message string, so update the assertion in the relevant test case
to verify the typed validation error shape instead. Use the existing error
helpers and `errors.As`/`errs.ProblemOf` in `helpers_test.go` to assert the
expected category, subtype, and `Param` for the native Mind Note URL case, while
still preserving the cause.
🪄 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

Run ID: 6d50b9d6-6972-49cd-9db1-c76be3d94e05

📥 Commits

Reviewing files that changed from the base of the PR and between 898e6d4 and 8f8638d.

📒 Files selected for processing (5)
  • shortcuts/doc/helpers.go
  • shortcuts/doc/helpers_test.go
  • skills/lark-doc/SKILL.md
  • skills/lark-drive/SKILL.md
  • skills/lark-whiteboard/SKILL.md

Comment thread shortcuts/doc/helpers_test.go
@fangshuyu-768

Copy link
Copy Markdown
Collaborator

Confirmed this PR is obsolete now. Main already documents and routes existing Mindnote operations through lark-doc / lark-cli mindnotes nodes list/create via #1581, including node read/create/update and mindnote_image upload support. The old unsupported-boundary direction here would now be misleading, so closing.

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

Labels

domain/ccm PR touches the ccm domain size/L Large or sensitive change across domains or core paths

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: clarify native mindnote editing is not currently supported

2 participants