docs: improve Installation section for AI assistant readability#27
Open
niujingjingbfsu wants to merge 5 commits intolarksuite:mainfrom
Open
docs: improve Installation section for AI assistant readability#27niujingjingbfsu wants to merge 5 commits intolarksuite:mainfrom
niujingjingbfsu wants to merge 5 commits intolarksuite:mainfrom
Conversation
…tputs Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
- 在安装章节顶部添加 AI 跳转提示 - 将「AI Agent 快速开始」移至「用户快速开始」之前 - 将 AI Agent 章节从 H2 降级为 H3(归入安装章节) - 补充前置条件说明、各步骤预期输出及交互步骤操作指引
|
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. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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:
Changes (README.md and README.zh.md):
## Installation & Quick Start### Quick Start (AI Agent)before### Quick Start (Human Users)Test
Fed both old and new README to Claude with prompt "Help me install lark-cli, use only this README":
node -vprereq checkThe 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.