feat(docs): streamline component onboarding - #2258
Conversation
0b4bc18 to
10a1b55
Compare
Forrest-ly
left a comment
There was a problem hiding this comment.
总体评价
Tokenless 组件的文档改动质量良好。重新组织了 Quick Start 章节,将 ANOLISA CLI、RPM、npm 安装路径前置并补充了 adapter 启用示例,中英文版本保持一致。根目录 QUICKSTART.md 中 tokenless 相关内容仅增加了 adapter 示例一行,无破坏性变更。
审查结论
approve
详细意见
🟡 建议修改(不阻塞但推荐)
- [src/tokenless/README.md:108–109] 新增的 Quick Start 代码块中
curl -fsSL https://get.agentic-os.sh | bash与export PATH="$HOME/.local/bin:$PATH"之间建议加一行空行或注释说明 PATH 设置的目的,让读者在复制时不会漏掉第二步。当前两行紧邻,初学者容易只复制第一行。 - [docs/user-guide/en/token-saving/tokenless/QUICKSTART.md:28] "If
anolisais already available, start withanolisa install tokenless." — 建议补充"可用"的判断标准(如which anolisa或anolisa --version),降低歧义。
🟢 值得肯定
- 安装优先级(ANOLISA CLI > RPM > npm > 源码构建)在中英文文档中表述完全一致,层次清晰。
anolisa adapter scan/enable/status三步示例为 tokenless 用户提供了完整的 adapter 启用流程,比之前只提"deploy all adapters"更具操作性。- PATH 恢复指引(
export PATH="$HOME/.local/bin:$PATH")解决了新用户安装后找不到命令的常见问题,中英文 QUICKSTART 均有补充。 - 原 npm Install 独立章节被合并到 Quick Start 中,消除了重复内容,结构更紧凑。
- 中英文文档同步更新,措辞和结构对齐良好。
- Separate package installation from systemd service activation. - Explain service mode and two-terminal foreground diagnostics. Supplements: fe12c88 ("feat(sight): integrate enforcement control") Signed-off-by: kongche-jbw <kongche.jbw@alibaba-inc.com>
- Use sec-core as the CLI name while retaining the RPM package name. - Lead package installs into adapter enablement and source fallbacks. Supplements: 50d5db7 ("feat(sec-core): add raw package support") Signed-off-by: kongche-jbw <kongche.jbw@alibaba-inc.com>
- Promote direct component entry points and put Quickstarts first. - Keep locale switching in the navbar and align Tokenless installation. Signed-off-by: kongche-jbw <kongche.jbw@alibaba-inc.com>
10a1b55 to
0d9f617
Compare
Forrest-ly
left a comment
There was a problem hiding this comment.
总体评价
本轮新 commit 主要调整文档结构、安装入口和 website 构建脚本,tokenless 相关文档(src/tokenless/README*、docs/user-guide/*/token-saving/tokenless/QUICKSTART.md)的内容准确性良好,中英文同步,安装路径和 adapter 示例与上一轮保持一致。
审查结论
approve
详细意见
🟡 建议修改(不阻塞但推荐)
- [website/scripts/prepare-docs.mjs:1186–1190]
isUserGuideQuickstart会把所有user-guide/*/quickstart.md都设为sidebar_position: 1。当前仓库里user-entrypoint/下同时存在copilot-shell/QUICKSTART.md和cosh-ng/QUICKSTART.md,PR 描述却只提到 "Tokenless, Copilot Shell, and AgentSecCore" 三份 quick start。这样会把两份 Copilot Shell 相关的 quick start(可能其中一份并非本意)都提升到首位,且多个条目共享 position 1 容易导致侧边栏排序不确定。建议把谓词收窄到明确的目标路径,或在 front matter 中为不同 quick start 显式指定1、2、3等不重复位置。
🟢 值得肯定
src/tokenless/README*把 CLI、RPM、npm 三种安装路径前置到 Quick Start,并保留源码构建作为开发者选项,结构更清晰。- 中英文文档对安装优先级(CLI > RPM > npm > 源码)和
anolisa adapter scan/enable/status三步流程的表述一致。 docs/user-guide/*/token-saving/tokenless/QUICKSTART.md补充了export PATH和 "已安装则跳过" 的说明,降低了新用户复制命令时的困惑。stripLocaleSwitchLinks()只处理行首的[English](...)/[中文版](...),配合check-links.mjs的新规则,能把语言切换统一收敛到导航栏,行为一致。
Code Review — PR #2258 (commit 0d9f617)总体结论:LGTM,无阻塞问题。 变更为文档 + 网站构建脚本,我把文档中的关键事实性声明逐条对照了 PR head 的代码,并在本地实际运行了修改过的构建脚本。 已验证(与代码一致)
建议(均不阻塞合并)
|
Forrest-ly
left a comment
There was a problem hiding this comment.
Code review 完成:整体 LGTM,无阻塞问题。
已对照 PR head 代码验证全部关键事实声明(sec-core 组件契约、CLI ≥ 0.2.16 gate、x86_64 system mode、RPM 包名、agentsight systemd 依赖与启动行为、build-all 目标、adapter 列表、update self/status/adapter status 命令),并本地运行 prepare-docs.mjs 确认 146 个文档生成、内联语言链接全部剥离、quickstart sidebar_position 生效。
留有 6 条非阻塞建议(详见 PR 总体评论),其中两条值得跟进:
- agentsight systemd 服务的 Dashboard 经 agentsight-start.sh 绑定 0.0.0.0,建议在文档 systemd 小节补充暴露面提示;
- index.tsx 中文 hook 改为 30~70% 后,同页中文 proof(line 186)仍是 30–70%,建议统一。
Forrest-ly
left a comment
There was a problem hiding this comment.
总体评价
Tokenless 文档改动的结构更清晰,安装优先级与 adapter 启用示例一致,PATH 恢复指引也覆盖了默认安装目录不在当前 shell PATH 的场景。但 PR 将 npm install 路径提升到 Quick Start 中,而公开 npm registry 上并不存在 anolisa-tokenless 包,这会导致直接复制命令的用户失败。
审查结论
request changes
详细意见
🔴 必须修改(阻塞合并)
- [src/tokenless/README.md:124-129] / [src/tokenless/README_zh.md:81-86]
Quick Start 将npm install -g anolisa-tokenless与 ANOLISA CLI、RPM、源码构建并列为支持路径,但当前仓库的 npm 包并不可用:npm view anolisa-tokenless返回 404;src/tokenless/npm/package.json中"private": true,且.npmrc指向registry.npmjs.org;- 可选依赖
@anolisa/tokenless-*同样未在 npm registry 发布。
在包未发布到可访问 registry 之前,不应把它作为 Quick Start 的正式安装入口。建议移除该路径,或补充"需发布/配置到可用 registry"的明确说明。
🟡 建议修改(不阻塞但推荐)
- [docs/user-guide/zh/token-saving/tokenless/QUICKSTART.md:31]
与 Forrest-ly 已指出的英文版问题对应,"如果当前环境已经能运行anolisa" 建议给出判断标准(如which anolisa或anolisa --version),降低新用户歧义。 - [src/tokenless/README.md:111-116] / [src/tokenless/README_zh.md:69-72]
与 docs/user-guide 的 QUICKSTART 保持一致,建议在export PATH与anolisa install tokenless之间加入anolisa --version验证步骤;同时curl | bash与export PATH两行紧邻,初学者容易只复制第一行,可加一行注释或空行说明。
🟢 值得肯定
- 中英文 README 的安装优先级(ANOLISA CLI > RPM > npm > 源码构建)表述一致,去掉了独立的 npm 安装章节后结构更紧凑。
anolisa adapter scan/enable tokenless openclaw/status tokenless三步示例完整,adapter 启用路径比旧版更清晰。- PATH 恢复指引(
export PATH="$HOME/.local/bin:$PATH")同时覆盖了用户指南和 README,解决了默认安装后找不到命令的常见问题。
| - Linux (x86_64 or aarch64) | ||
| - Linux x86_64 for the ANOLISA raw package | ||
| - Python 3.11.6 (pinned) | ||
| - ANOLISA CLI 0.2.16 or later |
There was a problem hiding this comment.
sec-core component.toml中, ANOLISA CLi最小支持版本是0.2.17
| ```bash | ||
| # Recommended (system mode required) | ||
| sudo anolisa install agent-sec-core | ||
| anolisa update self |
There was a problem hiding this comment.
这里推荐先以普通用户执行 anolisa update self,但同一套安装文档提供的标准 CLI 安装入口是 sudo yum install anolisa。对于 RPM-owned 的 anolisa,run_self_update_with_deps() 在检测到当前用户不是 root 时会直接失败,并明确要求重跑 sudo anolisa update self;因此用户恰在旧 CLI 需要升级时,按这条推荐流程无法继续。
建议区分 CLI 的安装来源:用户目录/脚本安装使用 anolisa update self,RPM 安装使用 sudo anolisa update self(或 sudo yum update anolisa),并同步修正中英文 installation、顶层 QUICKSTART、AgentSecCore QUICKSTART/README 中新增的相同命令。
|
|
||
| # 源码编译(仅开发者) | ||
| ```bash | ||
| cd src/agent-sec-core && make build-cli |
There was a problem hiding this comment.
这里不应直接向用户暴露组件内部的 make build-cli。ANOLISA 已维护统一的源码构建与安装入口 ./scripts/build-all.sh --component sec-core,它负责完整构建并安装 sec-core;make build-cli 只处理 CLI wheel,既不是项目对外推荐入口,也不会完成各 Agent 集成资源的安装。
这也导致后文继续引用 ./openclaw-plugin/scripts/deploy.sh、./hermes-plugin/scripts/deploy.sh 和 ./qwen-code-extension/scripts/deploy.sh 等源码树相对路径。用户通过统一脚本完成源码安装后,不应依赖源码仓库或当前工作目录,而应使用安装后的集成入口。建议 QUICKSTART 统一改用 build-all.sh,并将各框架示例调整为安装后的脚本路径或 anolisa adapter enable;仓库内的 Make target 和源码树调试方式放到开发文档中。
Why
The latest
anolisaCLI release changed the recommended AgentSecCoreinstallation flow, while the AgentSight and Tokenless guides still left key
startup and installation choices implicit. The website documentation also had
two competing language-switch paths that behaved differently.
What changed
documentation sidebar without changing the existing homepage narrative.
inline repository language links during the documentation build, with a link
check that prevents them from returning.
manual
traceandserveworkflow.anolisa install sec-coreflow introduced in CLI0.2.16+, while preserving the
agent-sec-coreRPM package name and adaptersetup details.
anolisa install tokenlesspath, add PATHrecovery guidance, and make the ANOLISA, RPM, npm, and source-build priority
explicit.
30~70%for the Chinese homepage percentage range while retaining theexisting English copy and scenario framing.
Preview: https://kongche-jbw.github.io/anolisa/
Related issue
no-issue: documentation onboarding and fork preview refinement
User / Agent impact
Users can reach the main component quick starts earlier in the documentation,
follow the current AgentSecCore and AgentSight startup flows, and switch
languages consistently from the website navigation.
Risk and compatibility
Documentation now reflects the released CLI behavior. No runtime code or
component interfaces changed, so compatibility risk is low.
Validation
bash scripts/docs-lint.shpython3 scripts/docs-link-check.pynpm run validate:locales --prefix websitenpm run typecheck --prefix websiteSITE_URL=https://kongche-jbw.github.io BASE_URL=/anolisa/ npm run build --prefix websiteSITE_URL=https://kongche-jbw.github.io BASE_URL=/anolisa/ npm run check:links --prefix websitehttps://github.com/kongche-jbw/anolisa/actions/runs/31076892647
Documentation and rollback
Updated the bilingual root quick starts, component READMEs, user guides, and
website documentation build scripts. Reverting the three commits restores the
previous installation guidance and navigation behavior.