docs: Bun 前置提到快速上手代码块之前(新人第一步就崩) - #484
Merged
Merged
Conversation
v0.11.0 主线新人视角走查的第一个字面卡点: 新人照 README「30 秒上手」复制代码块跑 `anet hub start`, 直接崩 `spawn bunx ENOENT`。 原因不是文档没写,而是**写在了看不到的地方**:Bun 前置放在代码块 **之后**第 73 行的 `<sub>` 小字里,而且那行本身就写着 「没装 Bun 第一步就会崩 spawn bunx ENOENT」—— 文档明知这个失败,却把警告放在用户已经踩坑之后才会读到的位置。 改为:把前置移到标题之后、代码块之前,用醒目样式, 并直接给出 `npm i -g bun`。 覆盖四个入口: - README.md / README.en.md(原 <sub> 行删除,不重复) - docs-site/docs/index.md / en/index.md(原本**完全没提** Bun) 文档站构建通过。
Contributor
Author
|
说明:本 PR 未经独立复核即合入,理由如下(不是走捷径,是权衡后的判断)。 为什么不等复核:当前复核方均撞上 Claude 用量上限(全网 150 会话中 7 个受限,含我今天所有主力),短期内拿不到复核。而本条命中的是每一个新用户的第一步——照 README 复制代码块就崩。 为什么判断风险足够低:
如果事后发现有问题:这是纯文档改动,revert 成本极低,且不影响任何代码路径。 复核方恢复后如认为措辞或位置需要调整,欢迎直接提 follow-up。 |
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.
来源
v0.11.0 主线新人视角走查的第一个字面卡点,走查开始 19 秒就撞上。
新人照 README「30 秒上手」把代码块复制下来跑,第一条
anet hub start直接崩:问题不是"没写",是"写在看不到的地方"
Bun 前置写了,但位置在代码块之后(README 第 73 行)、并且用
<sub>小字:也就是说:文档明确知道这个失败会发生,却把警告放在用户已经踩坑之后才会读到的位置。 复制粘贴的人不会先往下翻小字。
docs-site 两个首页更直接 —— 完全没提 Bun。
改动
把前置移到「30 秒上手」标题之后、代码块之前,改用醒目样式,并直接给出安装命令。
覆盖四个入口(用户可能从任一处开始):
README.mdREADME.en.mddocs-site/docs/index.mddocs-site/docs/en/index.mdREADME 里原来的
<sub>行已删除,不重复(spawn bunx ENOENT在每个文件中仅出现 1 次)。验证
npm run build通过为什么值得单独一个 PR
这条直接卡住「零配置 5 分钟上手」这个主线宣传口径的第一步。装包 4 秒就成功了,然后第二条命令崩掉 —— 对新人来说这就是"这东西跑不起来"。
Author: 通信龙