Skip to content

docs: improve Installation section for AI assistant readability#27

Open
niujingjingbfsu wants to merge 5 commits intolarksuite:mainfrom
niujingjingbfsu:improve-readme-ai-install
Open

docs: improve Installation section for AI assistant readability#27
niujingjingbfsu wants to merge 5 commits intolarksuite:mainfrom
niujingjingbfsu:improve-readme-ai-install

Conversation

@niujingjingbfsu
Copy link
Copy Markdown

Summary

When an AI assistant (e.g. Claude, Cursor) reads this README to help a user install lark-cli, it currently faces several friction points that cause it to follow a suboptimal installation path.

Problems fixed:

  • The AI Agent Quick Start was positioned after the human section — AI reading top-to-bottom would see the human steps first
  • No prominent redirect notice at the top of the Installation section
  • Interactive steps (Steps 3 & 4) used vague wording ("run in the background", "same as above") without explaining the expected URL format or what to do with it
  • No expected outputs for any step — AI couldn't verify whether a step succeeded

Changes (README.md and README.zh.md):

  • Added AI redirect notice at the top of ## Installation & Quick Start
  • Moved ### Quick Start (AI Agent) before ### Quick Start (Human Users)
  • Removed the now-redundant buried inline AI note from the human section
  • Added prerequisites note, expected outputs for all 5 steps, and clearer URL handling instructions for Steps 3 & 4

Test

Fed both old and new README to Claude with prompt "Help me install lark-cli, use only this README":

Old README New README
Follows AI Agent 5-step path
Includes node -v prereq check
URL format hint for auth steps
Per-step expected output

The new version produces a materially more complete installation guide.

Notes

Happy to adjust wording or structure based on feedback. The Chinese translation in README.zh.md is my best effort — native review welcome.

Dev and others added 5 commits March 28, 2026 17:31
…tputs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- 在安装章节顶部添加 AI 跳转提示
- 将「AI Agent 快速开始」移至「用户快速开始」之前
- 将 AI Agent 章节从 H2 降级为 H3(归入安装章节)
- 补充前置条件说明、各步骤预期输出及交互步骤操作指引
@CLAassistant
Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Dev seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants