Skip to content

docs: simplify lark base create guidance#459

Open
kongenpei wants to merge 1 commit intolarksuite:mainfrom
kongenpei:fix-empty-base
Open

docs: simplify lark base create guidance#459
kongenpei wants to merge 1 commit intolarksuite:mainfrom
kongenpei:fix-empty-base

Conversation

@kongenpei
Copy link
Copy Markdown
Collaborator

@kongenpei kongenpei commented Apr 13, 2026

Summary

Tighten the lark-base base-create guidance by removing duplicated wording in the default-table deletion notes.

Changes

  • simplify the 注意事项 section for default empty table handling
  • keep the deletion-safety rules explicit and unchanged in intent

Test Plan

  • Unit tests pass
  • Manual local verification confirms the documentation wording is concise and consistent

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Updated post-creation guidelines for Bases with detailed default table management specifications. Added conditions for deletion requests, prerequisite steps for deletion execution, and clarified timing constraints preventing immediate deletion after creation.

@kongenpei kongenpei requested a review from zgz2048 April 13, 2026 16:26
Copy link
Copy Markdown

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

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

kongenpei has reached the 50-review limit for trial accounts. To continue receiving code reviews, upgrade your plan.

@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 Apr 13, 2026
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 13, 2026

📝 Walkthrough

Walkthrough

Documentation update adding post-creation behavior specifications for the Lark Base feature. Specifies that newly created Bases include one default empty table with 5–10 empty records, and defines detailed rules governing when deletion of this default table may be suggested or executed.

Changes

Cohort / File(s) Summary
Base Creation Documentation
skills/lark-base/references/lark-base-base-create.md
Added post-creation instructions detailing default table behavior and comprehensive deletion decision rules, including constraints on deletion timing, user requirements for deletion execution, and prerequisites for table identification before deletion.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Suggested labels

domain/base, size/M

Suggested reviewers

  • zgz2048

Poem

🐰 A Base is born with tables bright,
One default friend, prepared just right,
With records waiting, empty and free,
Deletion rules for you to see—
Ask not too soon, but when you're set,
The clearest Base you'll ever get! 📋✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title 'docs: simplify lark base create guidance' is concise and directly relates to the main change: simplifying documentation for base creation, specifically tightening guidance by removing duplicated wording.
Description check ✅ Passed The PR description includes all required template sections: Summary (explains the simplification of default-table deletion notes), Changes (lists specific modifications), Test Plan (with manual verification checked), and Related Issues (marked as None).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

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 the current code and only fix it if needed.

Inline comments:
In `@skills/lark-base/references/lark-base-base-create.md`:
- Line 70: 在文档中删除重复的“不在创建后立刻询问是否删除”的表述:保留该禁止规则仅在“禁止事项”(当前摘录处的行 89
所在段落,标识为禁止事项)并删除工作流步骤 5(标注为把默认表视为“默认保留”后紧跟的那句)和注意事项段落中重复的句子;在注意事项(当前行
103)改为一句简短的交叉引用,提示“关于创建后删除的禁止规则见禁止事项”,以避免重复并保持语义一致。
🪄 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: 8f68c9c5-9e4a-491a-bd1e-e6e3b864b10d

📥 Commits

Reviewing files that changed from the base of the PR and between 2910cde and 9283ead.

📒 Files selected for processing (1)
  • skills/lark-base/references/lark-base-base-create.md

2. `--folder-token`、`--time-zone` 都是可选项;用户没要求时不要为此额外追问。
3. 创建成功后,整理并返回:Base 名称、token,以及响应中已有的可访问链接。
4. 创建成功时,只需说明:新 Base 里会自带 1 张默认空表,表内会预置 5-10 行空记录。
5. 把这张默认表视为“默认保留”;不要在创建成功这一轮立刻追问用户是否删除。
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion | 🟠 Major

Duplicated guidance about not asking immediately after creation.

The same prohibition appears three times with only minor wording variations:

  • Line 70 (workflow): "不要在创建成功这一轮立刻追问用户是否删除"
  • Line 89 (禁止事项): "不要在刚创建 Base 后立刻追问是否删除"
  • Line 103 (注意事项): "不要在创建后立刻询问是否删除"

This contradicts the PR objective to "remove duplicated wording in the default-table deletion notes." Consider consolidating:

  • Keep the prohibition in line 89 (禁止事项 section) where it belongs with other "don't do" rules
  • Remove from line 70 since step 5 already says to treat the default table as "默认保留" (keep by default)
  • In line 103, reference the detailed rules above instead of repeating the prohibition
♻️ Suggested consolidation
 3. 创建成功后,整理并返回:Base 名称、token,以及响应中已有的可访问链接。
 4. 创建成功时,只需说明:新 Base 里会自带 1 张默认空表,表内会预置 5-10 行空记录。
-5. 把这张默认表视为"默认保留";不要在创建成功这一轮立刻追问用户是否删除。
+5. 把这张默认表视为"默认保留"。

And simplify the notes section:

 ## 注意事项
 
-- 处理原则是"先告知、默认保留、触发后再问",不要在创建后立刻询问是否删除。
+- 处理原则是"先告知、默认保留、触发后再问";具体规则见上方"默认表删除决策规则"。
 - 即使用户已同意删除,也不要直接假设默认表的 `table_id` 或名称;先列出表,再基于真实返回结果删除。

This keeps the prohibition once in the 禁止事项 section where it logically belongs, and avoids repeating it in the workflow and notes.

Also applies to: 89-89, 103-103

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@skills/lark-base/references/lark-base-base-create.md` at line 70,
在文档中删除重复的“不在创建后立刻询问是否删除”的表述:保留该禁止规则仅在“禁止事项”(当前摘录处的行 89 所在段落,标识为禁止事项)并删除工作流步骤
5(标注为把默认表视为“默认保留”后紧跟的那句)和注意事项段落中重复的句子;在注意事项(当前行
103)改为一句简短的交叉引用,提示“关于创建后删除的禁止规则见禁止事项”,以避免重复并保持语义一致。

@github-actions
Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@9283eadc95e15db5537540573d603c01b3d58f44

🧩 Skill update

npx skills add kongenpei/lark-cli#fix-empty-base -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.

2 participants