Skip to content

docs: Add FAQ section for common questions#322

Open
meichuanyi wants to merge 1 commit into
openxlings:mainfrom
meichuanyi:docs/add-faq-section
Open

docs: Add FAQ section for common questions#322
meichuanyi wants to merge 1 commit into
openxlings:mainfrom
meichuanyi:docs/add-faq-section

Conversation

@meichuanyi

Copy link
Copy Markdown

Adds comprehensive FAQ section covering:

  • What is xlings (universal package infrastructure)
  • Comparison with other tools (apt/brew/nix/docker)
  • 3-level SubOS isolation (shell/FS/image)
  • Installation guide (Linux/macOS/Windows/AI agent)
  • Multi-version package usage examples
  • Project-level SubOS workflow
  • Agent integration and JSON interface
  • Package types and decentralized index
  • License and help resources

This FAQ addresses common questions for developers and AI agents using xlings package manager.

@meichuanyi meichuanyi requested a review from Sunrisepeak as a code owner June 6, 2026 09:11

@Sunrisepeak Sunrisepeak left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

PR Review 报告

范围: README.md +155/-1(FAQ 章节)。已对照仓库源码、LICENSE、base README 与 README.zh.md 逐项核实。

总体结论

⚠️ 不建议按现状合并。FAQ 立意不错,但存在 1 个事实性错误(license 写错)2 个 markdown 结构问题,且约 90% 的内容是对 README 已有章节的复述,多处复述版本与原文已经不一致,合并后会形成长期漂移的双份文案。

发现明细(按严重度排序)

🔴 严重

1. License 写错:声称 MIT,实际是 Apache-2.0("Is xlings free to use?" 一节)
FAQ 写 **License:** MIT,但仓库 LICENSE 文件是 Apache License 2.0(copyright d2learn,文件中 0 处 "MIT")。Apache-2.0 与 MIT 条款有实质差异(专利授权、NOTICE/修改声明要求),下游用户据此可能产生合规问题。必须修正。

2. Rootless 声明自相矛盾(对比表 vs 三级隔离表)
FAQ 对比表给 xlings 的 Rootless 打了无条件 ✅,但同一 FAQ 里的 SubOS 三级表写 Image-level "🔒 Root needed";而 base README 原表写的是 ✅ (except image mode)——准确版本被复述成了不准确的版本。

🟠 结构问题

3. 多出一个孤立的 #(空 H1 标题)(FAQ 标题前一行)
# 在 GitHub 渲染为空的一级标题,文档因此出现第二个 H1,破坏 outline/TOC(markdownlint MD041/MD002 会报)。看起来是笔误,应删除。

4. 顺手把 ### Contributing 提级成了 ## Contributing
Contributing 原是 ## Community 下的 H3 子节,被这个与 FAQ 无关的改动提为顶级 H2,且 155 行 FAQ 插在 Community 内容和 Contributing 之间,把原本紧凑的收尾区块(Community/Contributing/Contributors)劈开了。

🟡 维护性(重复/漂移)

5. 几乎每个 FAQ 条目都是已有章节的复制,且多处已分叉

  • 对比表 ×2:README 已有 10 行的 "vs. other tools" 表,FAQ 又造了一个 5 列简化版,结论还不一致(见 #2
  • 安装命令 ×2:curl/irm 一行命令和 "AI agent prompt" 与 Quick Start 近乎逐字重复——curl | bash 这类安全敏感命令存两份,URL 变更时极易漏改一处
  • .xlings.json 示例 ×2:FAQ 版丢掉了原示例里的 "llvm": {"macosx": ...},macOS 用户照 FAQ 抄会得到不完整模板
  • 三级隔离表 ×2:与 SubOS Deep Dive 表重复,且 FAQ 把 FS-level 标成 "🔓 Host access",与同节下一句 "host untouched" 自相矛盾
  • "Where can I get help" 表:与 Community 节、页头链接区第三次罗列求助渠道,还漏掉了 QQ 群

6. README.zh.md 完全没同步:仓库有平行的中文 README,FAQ 只加在英文版,两个 README 即刻分叉;而中文社区(QQ 群、d2learn 论坛)恰是主要受众。

7. 体量与位置:README 从 344 行膨胀到 ~499(+45%),FAQ 还内联链接了 docs/ 和官网——这些内容更适合放 docs/faq.md(或官网 FAQ 页),README 里留一个链接即可。

✅ 核实无误的部分(值得肯定)

所有 CLI 命令均与代码一致:多包安装、xlings use gcc@16xlings listxlings interface(NDJSON)、subos new --from / subos use --sandbox.xlings.json 的 per-OS schema 均经源码核实存在;"cd 即生效" 的体验经源码(CWD walk-up + multicall shim 分发)验证属实。安装脚本路径、xim-pkgindex 仓库名、论坛/官网链接也都正确。

建议处理方式

  1. 必改:MIT → Apache-2.0;删除裸 #;恢复 ### Contributing;修正 Rootless 为 ✅ (except image mode)
  2. 建议:把 FAQ 移到 docs/faq.md,重复内容改为指向 README 既有章节的链接;或大幅瘦身为"链接式 FAQ"
  3. 若保留在 README:同步 README.zh.md,并把 FAQ 移到 Contributing 之后

Review generated with Claude Code

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