Skip to content

docs: clarify Mindnote token discovery#1827

Open
fangshuyu-768 wants to merge 1 commit into
mainfrom
codex/mindnote-token-guidance
Open

docs: clarify Mindnote token discovery#1827
fangshuyu-768 wants to merge 1 commit into
mainfrom
codex/mindnote-token-guidance

Conversation

@fangshuyu-768

@fangshuyu-768 fangshuyu-768 commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • clarify that mindnote_id is the Mindnote document token, not a node ID
  • document Drive +inspect/+search flows for resolving Mindnote tokens from URLs, Wiki links, titles, or keywords
  • add top-level lark-doc routing guidance for Mindnote lookup when no URL/token is provided

Tests

  • git diff --check

Summary by CodeRabbit

  • Documentation
    • Clarified the workflow for operating an existing Mindnote when no URL or token is provided, including how to locate the Mindnote document token first.
    • Added steps to resolve and validate the correct Mindnote document token (distinguishing it from node IDs and avoiding passing wiki tokens directly).
    • Updated the recommended workflow to confirm the target is a Mindnote before proceeding, and added relevant reference links.

@coderabbitai

coderabbitai Bot commented Jul 9, 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

Run ID: 2964dbde-99a0-4438-b0b2-568404b6e86a

📥 Commits

Reviewing files that changed from the base of the PR and between 117628b and 4153896.

📒 Files selected for processing (2)
  • skills/lark-doc/SKILL.md
  • skills/lark-doc/references/lark-doc-mindnote.md
✅ Files skipped from review due to trivial changes (1)
  • skills/lark-doc/references/lark-doc-mindnote.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • skills/lark-doc/SKILL.md

📝 Walkthrough

Walkthrough

This PR updates lark-doc guidance to clarify how to resolve mindnote_id for existing mindnotes without a provided URL or token, including Drive inspect/search steps and a new reference link.

Changes

Mindnote token resolution documentation

Layer / File(s) Summary
SKILL.md routing guidance update
skills/lark-doc/SKILL.md
Adds a Drive search step to find the Mindnote document token before following the existing mindnote path when no URL or token is provided.
Mindnote id resolution procedure and workflow integration
skills/lark-doc/references/lark-doc-mindnote.md
Adds a new mindnote_id resolution section, updates the recommended workflow to use the resolved Mindnote token and confirm the target type, and adds a lark-drive reference link.

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

Possibly related PRs

  • larksuite/cli#1508: Updates the same skills/lark-doc/SKILL.md “快速决策” workflow-path guidance.
  • larksuite/cli#1581: Updates the same mindnote routing documentation in skills/lark-doc/SKILL.md and skills/lark-doc/references/lark-doc-mindnote.md.
  • larksuite/cli#1801: Also uses lark-cli drive +inspect/+search to resolve the correct drive resource token/type.

Suggested reviewers: liangshuo-1, wittam-01, SunPeiYang996

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers Summary and Tests, but it omits the template's required Changes and Related Issues sections. Add a Changes section with the main bullets, include Related Issues (or None), and expand Test Plan to match the repository template.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the Mindnote token discovery documentation update.
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
  • Commit unit tests in branch codex/mindnote-token-guidance

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/M Single-domain feat or fix with limited business impact labels Jul 9, 2026
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 74.44%. Comparing base (74d8458) to head (4153896).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1827   +/-   ##
=======================================
  Coverage   74.44%   74.44%           
=======================================
  Files         860      860           
  Lines       89859    89859           
=======================================
  Hits        66897    66897           
  Misses      17778    17778           
  Partials     5184     5184           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@117628bd5d05ce5a650b5c22aa3230c37d2a3a89

🧩 Skill update

npx skills add larksuite/cli#codex/mindnote-token-guidance -y -g

@fangshuyu-768

fangshuyu-768 commented Jul 9, 2026

Copy link
Copy Markdown
Collaborator Author

Verified with a real Wiki-wrapped Mindnote URL.

  • lark-cli drive +inspect --url <wiki-url> --as user --format json unwraps the Wiki node to type: mindnote and returns the canonical Mindnote token.
  • lark-cli mindnotes nodes list --mindnote-id <mindnote-token> --as user --format json succeeds and returns nodes.
  • Passing the Wiki node token directly to --mindnote-id fails with 3410003 resource not found.

This confirms the doc needs to explicitly route Wiki/title lookup through Drive before calling mindnotes nodes list.

@fangshuyu-768 fangshuyu-768 force-pushed the codex/mindnote-token-guidance branch from 117628b to 4153896 Compare July 9, 2026 08:11
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/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