文档导航

August 16, 2026 · View on GitHub

这里是仓库文档的统一入口。根目录 README 面向使用者;本目录保存架构、构建、发布和排错等维护资料。

文档面向对象维护范围
系统要求与兼容基线使用者/维护者每个版本固定的最低系统、内核/构建基线与运行时依赖
已知问题与平台支持边界使用者/维护者各平台已确认缺陷、推断风险、设备验证缺口与临时规避方案
架构说明开发者分层、启动序列、信任边界、目录职责
品牌与应用图标使用者/维护者图标含义、权利边界、资源格式与再生成
开发与构建开发者固定工具链、本地命令、原生包构建
发布流程维护者版本、标签、六平台产物、签名边界
故障排查使用者/维护者安装目录、Node、代理、日志、平台问题
开源工程参考维护者采用的上游做法和取舍依据
贡献指南贡献者改动范围、测试和 PR 证据
安全策略使用者/研究者私密报告与日志脱敏
作者与维护者所有人项目作者、联系方式、维护职责与贡献记录
版权与第三方许可说明使用者/分发者/贡献者MIT 权利义务、版权所有者与第三方边界
变更日志所有人已发布和未发布的用户可见变化

文档维护规则

  1. 平台缺陷、设备验证缺口或临时规避方案统一更新 KNOWN_ISSUES.md,并明确区分“已确认”“推断”和“未验证”;
  2. 文件职责、启动序列或边界变化时更新 ARCHITECTURE.md
  3. 命令、工具版本或目录变化时更新 BUILDING.md
  4. 图标含义、源文件或生成方式变化时更新 BRANDING.md
  5. 产物、标签或 Actions 变化时更新 RELEASING.md;系统基线变化还必须同步 release-requirements.jsonSYSTEM_REQUIREMENTS.md
  6. 用户可见行为同时更新根 README 和 TROUBLESHOOTING.md
  7. 不复制整段规范到多个文件,优先链接到唯一说明;
  8. 作者、版权所有者、分发内容或第三方依赖变化时更新根目录 AUTHORS.mdLICENSENOTICE.md
  9. 运行 npm --prefix frontend run docs:check,拒绝指向不存在文件的本地链接。