Skip to content

docs: clarify network requirements in README (#40)#47

Merged
SonicBotMan merged 3 commits into
mainfrom
fix/issue-40-readme-clarification
Mar 15, 2026
Merged

docs: clarify network requirements in README (#40)#47
SonicBotMan merged 3 commits into
mainfrom
fix/issue-40-readme-clarification

Conversation

@SonicBotMan

@SonicBotMan SonicBotMan commented Mar 15, 2026

Copy link
Copy Markdown
Owner

📝 Documentation Fix

Fixes #40

Problem

README 宣称「完全离线运行」，但实际首次运行需要联网下载 Node.js 和 OpenClaw（~60MB）。这误导了用户，在完全离线环境下会失败。

Changes

1. 更新标题

  • Before: 完全离线 AI 助手
  • After: 首次联网，后续离线

2. 更新核心优势

  • 明确说明「首次联网自动安装」
  • 区分「首次需要网络」和「后续需要网络」

3. 更新对比表格

特性 Before After
需要网络 ❌ 不需要 ✅ 首次（~60MB）
后续需要网络 ❌ 不需要 ❌ 不需要

4. 新增注意事项

  • 首次运行需要网络（~60MB）
  • AI 对话需要网络连接
  • Git 功能需要网络

5. 更新常见问题

  • 新增「为什么首次需要网络」FAQ
  • 新增「如何在完全离线环境使用」FAQ

6. 其他修正

  • 更新端口号：3000 → 18789
  • 更新版本号：4.1.0 → 5.0.1
  • 更新包大小说明：区分下载包（~1MB）和安装后（~679MB）

Impact

  • ✅ 诚实描述网络需求
  • ✅ 管理用户期望
  • ✅ 避免离线环境中的困惑
  • ✅ 保持便携版的核心价值（后续离线）

Testing

  • Review README for accuracy
  • Check all network-related claims
  • Verify FAQ completeness

Priority

🟠 P1 High - Documentation accuracy affects user experience

This PR was created automatically by AI assistant

SonicBotMan added 3 commits March 15, 2026 05:17
fix: resolve UTF-8 encoding issue in start.bat (#44)
273f31a 
- Remove all Chinese characters from start.bat
- Convert to pure English for better compatibility
- Add .gitattributes to enforce correct line endings
- Add .editorconfig to prevent future encoding issues

Fixes #44
Related #37
fix: resolve multiple critical bugs in start.sh (#36)
8f59070 
Bug Fixes:
- Fix SCRIPT_DIR undefined variable (critical)
- Remove export HOME pollution
- Add multi-platform Git installation support
- Remove set -e, use manual error handling
- Use rsync for incremental sync

Improvements:
- Correct gateway port (3000 -> 18789)
- Graceful failure when Git install fails
- Better error messages

Fixes #36
docs: clarify network requirements in README (#40)
66ed3d8 
Changes:
- Update title: "完全离线" → "首次联网，后续离线"
- Add first-run network requirement (~60MB download)
- Distinguish between "first run" and "subsequent runs"
- Update comparison tables with accurate network info
- Add FAQ explaining first-run network needs
- Correct gateway port (3000 → 18789)
- Update version to 5.0.1

Fixes #40
@SonicBotMan SonicBotMan merged commit 0204fa6 into main Mar 15, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

[核心缺陷] README 宣称「完全离线」但实际首次运行需联网下载 Node.js 和 OpenClaw

1 participant

@SonicBotMan