已开启
docs: 重写中英文 README,并把 run 子命令补进英文部署指南 #132
docs: 重写中英文 README,并把 run 子命令补进英文部署指南 #132
已开启
chendanyang创建于 9 天前
chendanyang
chendanyang成员
9 天前

概述

重写中英文 README。原文的开头是一句话定位紧跟一段安全免责声明,四条特性是不链接任何页面的散文,"安装"一节从不说去哪里拿可执行文件,中文「项目定位」逐字重复了开头的介绍语而英文同一位置讲的是架构,两份 README 都没有提到 CLI。本 PR 不涉及运行代码。

主要变更

  • 两份 README 重排为:居中标题 + 徽章 + 导航行 → 会话截图 → 这是什么 → 安装 → 配置模型 → 第一个任务 → 能做什么 → 命令行 → 环境要求 → 工作原理 → 文档 → 许可证;中英结构与主张完全对齐,中文「项目定位」不再自我重复。
  • 特性改为可扫读的表格,每一行都链接到记录它的页面,claim 从"请相信"变成"点进去看"。
  • 安装一节给出 release 0.2.0 的真实下载链接(x86_64 可粘贴的 curl,aarch64 在旁),并补上 serve 之后要在浏览器打开 http://127.0.0.1:4310、用启动时打印的 token 登录 —— 原文缺这一步。
  • 新增「配置模型」一节,点名两个界面:模型注册表填服务商与 API Key,全局默认值选任务模型。原文只写"在 Global defaults 配置任务模型",而 Key 并不填在那里。
  • 新增「命令行」一节,并把 run 子命令整节补进英文部署指南(命令表那一行、双终端示例、text/jsonl 模式切换、非交互必须 --auto-approve)—— 此前 run 只有中文文档记录。
  • [!WARNING] 安全声明一字未改,仅从开篇移到上手路径之后,使其读作适用范围而非产品的开场白。
  • 未沿用「300+ 跨领域 Skills」这一数字:它只出现在两份 README,仓库与文档中无任何出处,而 skills/ 实际为 18 个。能力描述保留,数字请由维护者带出处补回。

变更文件

  • README.md
  • README_zh.md
  • docs/en/how-to/deployment.md

验证

  • 未运行 ci:ut / ci:e2e:本机为 macOS,无 bubblewrap,两层均依赖真实沙箱。
  • 本 PR 不修改运行代码。

关联说明

对应镜像仓 issue openJiuwen-ai/sciencediscovery#27(README 重构)与 #30(README 介绍 CLI)。

likedislike
合并受阻
chendanyangchendanyang成员
9 天前 关联了issue:[Feature]: 重构 Skill 发现与加载机制,避免全量 metadata 注入和召回退化,[Feature] 支持插件式 Execution Mode 与 Plan Mode
atomgit-bot
atomgit-bot
9 天前 评论:

变更摘要

本 PR 为纯文档改动(不涉及任何运行代码),核心工作是重写中英文 README.md / README_zh.md 并将 run 子命令整节补进英文部署指南 docs/en/how-to/deployment.md。两份 README 被重排为同一套结构(居中标题 + 徽章 + 导航行 → 会话截图 → 这是什么 → 安装 → 配置模型 → 第一个任务 → 能做什么 → 命令行 → 环境要求 → 工作原理 → 文档 → 许可证),中英结构完全对齐,中文「项目定位」不再自我重复;特性改为每行带出处链接的可扫读表格;安装一节给出 release 0.2.0 的真实下载地址并补上 serve 后的浏览器登录步骤;新增「配置模型」与「命令行」两节;[!WARNING] 安全声明一字未改、仅从开篇移到上手路径之后;同时删除了无出处的「300+ 跨领域 Skills」数字(skills/ 实际为 18 个)。

主要改动

  • README 重构与中英对齐: 两份 README 重排为相同章节顺序与主张,消除中文「项目定位」对开篇介绍的逐字重复,使中英文档结构完全一致。
  • 特性表格化并链接出处: 特性从散文改为可扫读的表格,每一行均链接到记录该特性的页面,将「请相信」式的 claim 变为「点进去看」。
  • 补齐安装与启动登录流程: 安装一节给出 release 0.2.0 的真实下载链接(x86_64 可直接粘贴的 curl,aarch64 并列给出),并补上原文缺失的步骤:serve 之后在浏览器打开 [INTERNAL_URL]、用启动时打印的 token 登录。
  • 新增「配置模型」与「命令行」两节: 「配置模型」点名两个界面——模型注册表填服务商与 API Key、全局默认值选任务模型(Key 并不填在默认值里);「命令行」一节连同 run 子命令的完整内容(命令表行、双终端示例、text/jsonl 模式切换、非交互必须 --auto-approve)一并写入英文部署指南。
  • 调整安全声明位置并删除无出处数字: [!WARNING] 免责声明仅从开篇移到上手路径之后、内容一字未改,使其读作适用范围;「300+ 跨领域 Skills」因仓库与文档中无任何出处而被移除,能力描述保留、数字待维护者带出处补回。
likedislike
不准确?
atomgit-bot
atomgit-bot
9 天前 评论:

🤖 本次改动均为数据 / 生成 / 二进制文件(如测试用例、锁文件、媒体资源),没有可审查的代码逻辑,已跳过 AI 代码审查。

likedislike
不准确?
openJiuwen-bot成员
9 天前 评论:

欢迎来到 openJiuwen 社区

Hey @birfied , 感谢你对社区的贡献.

机器人使用手册

有关指令的使用,可以点击 此处 查看详情。开发人员可以在每个PR或Issue下方评论特定指令来触发机器人任务。

likedislike
atomgit-bot
atomgit-bot
9 天前 评论:

AtomGit AI 助手使用指南

在 PR 评论中使用命令即可触发。支持在普通评论和代码行评论中使用。

功能 命令 说明
代码审查 /ai review 检查代码质量、潜在问题、安全风险
PR 摘要 /ai summary 生成 PR 变更内容的结构化摘要
代码解释 /ai explain 解释代码变更的逻辑和意图
自由提问 @atomgit-bot <问题> 询问关于本 PR 的任何问题
帮助 /ai help 显示此帮助信息

免责声明

AI 助手可能存在误判,请结合自身判断。可以对评论点 👍 或 👎 帮助我们改进。

likedislike
不准确?
此处折叠了55条消息 查看更多
openJiuwen-bot成员
9 天前 评论:

✅ 流水线 479166b6a0b84c33ab67d41d4013db4f 执行成功。

可在 https://gitcode.com/openJiuwen/sciencediscovery/pull/132/check 查看完整构建日志。

在 PR 评论中发送 rerun 可重新触发 CI 流水线。

任务名称子任务状态详情
代码检查SCA(开源合规)PASSED点此跳转
Anti-poison(防投毒)PASSED点此跳转
CodeCheck(静态检查)PASSED点此跳转
Blacklist(禁用词)PASSED点此跳转
UThost tierPASSED公开日志
guest tier (QEMU TCG sandbox)PASSED公开日志
ST-PASSED公开日志
Binaryx86_64 debug packagePASSEDbinary · SHA256SUMS
aarch64 debug packagePASSEDbinary · SHA256SUMS
likedislike
OopenJiuwen-bot成员
9 天前 添加了label:ci-successful
OopenJiuwen-bot成员
9 天前 删除了label:ci-running
openJiuwen-bot成员
9 天前 评论:

✅ 流水线 43e819c0cab94eab91aa184189e95714 执行成功。

可在 https://gitcode.com/openJiuwen/sciencediscovery/pull/132/check 查看完整构建日志。

在 PR 评论中发送 rerun 可重新触发 CI 流水线。

任务名称子任务状态详情
代码检查SCA(开源合规)PASSED点此跳转
Anti-poison(防投毒)PASSED点此跳转
CodeCheck(静态检查)PASSED点此跳转
Blacklist(禁用词)PASSED点此跳转
UThost tierPASSED公开日志
guest tier (QEMU TCG sandbox)PASSED公开日志
ST-PASSED公开日志
Binaryx86_64 debug packagePASSEDbinary · SHA256SUMS
aarch64 debug packagePASSEDbinary · SHA256SUMS
likedislike
openJiuwen-bot成员
9 天前 评论:

✅ 流水线 9a73ddff45e64d849adbca5db65d27c4 执行成功。

可在 https://gitcode.com/openJiuwen/sciencediscovery/pull/132/check 查看完整构建日志。

在 PR 评论中发送 rerun 可重新触发 CI 流水线。

任务名称子任务状态详情
代码检查SCA(开源合规)PASSED点此跳转
Anti-poison(防投毒)PASSED点此跳转
CodeCheck(静态检查)PASSED点此跳转
Blacklist(禁用词)PASSED点此跳转
UThost tierPASSED公开日志
guest tier (QEMU TCG sandbox)PASSED公开日志
ST-PASSED公开日志
Binaryx86_64 debug packagePASSEDbinary · SHA256SUMS
aarch64 debug packagePASSEDbinary · SHA256SUMS
likedislike