Skip to content

优化上手体验：一键安装 + 文档重组 + 工作流模板 + 搜索脚本#27

Open
Yhazrin wants to merge 8 commits intojnMetaCode:mainfrom
Yhazrin:main
Open

优化上手体验：一键安装 + 文档重组 + 工作流模板 + 搜索脚本#27
Yhazrin wants to merge 8 commits intojnMetaCode:mainfrom
Yhazrin:main

Conversation

@Yhazrin
Copy link
Copy Markdown

@Yhazrin Yhazrin commented Mar 22, 2026

本 PR 聚焦 新用户的上手体验，不改动任何智能体内容本身。核心思路：一行命令装好，3 分钟内能用。

新增功能

  1. 一行 curl 安装（setup.sh）
  • 自动检测本机已安装的 AI 工具
  • 只对需要格式转换的工具调用 convert.sh（Claude Code/Copilot 直接复制源 .md，跳过转换）
  • 安装完成后可选打开 Web 引导页或终端引导
  • 用法：curl -fsSL https://raw.githubusercontent.com/.../setup.sh | bash
  1. Web 使用引导（guide.html）
  • 自包含单 HTML 文件，内嵌 CSS，无外部依赖
  • 深色/浅色自适应，响应式布局
  • 包含智能体列表、激活方式、示例 prompt、工作流案例
  1. 文档拆分
  • docs/QUICKSTART.md — 3 分钟快速上手（curl 安装 / clone 安装 / 手动复制三种路径）
  • docs/TOOLS-GUIDE.md — 12 种工具的详细安装配置说明（从 README 中拆出）
  • docs/CHEATSHEET.md — 最常用 10 个智能体 + 复制即用 prompt 速查表
  1. 工作流模板（workflows/）
  • 预定义多智能体协作流程，用户直接套用
  • 包含：代码审查流水线、营销活动、产品发布全流程
  1. 实用脚本
  • scripts/search-agents.sh — 按关键词搜索智能体名称和描述
  • scripts/create-agent.sh — 交互式创建自定义智能体
  • scripts/sync-upstream.sh — 自动同步上游英文版新增的智能体
  1. 代码审查工作流示例（examples/workflow-code-review.md）
  • 展示代码审查员 + 安全工程师 + 性能基准师的协作流程

修复

  • scripts/lint-agents.sh — 补全缺失的 6 个目录（academic、finance、hr、legal、supply-chain、sales），使 lint 覆盖全部智能体
  • scripts/install.sh — check_integrations() 改为找不到 integrations/ 时自动调用 convert.sh，而非报错退出
  • .gitignore — 移除 integrations/ 排除，允许预转换文件随仓库提交

精简

  • README.md 从 289 行精简到 ~200 行
  • 各工具详细安装说明移到 docs/TOOLS-GUIDE.md
  • 智能体列表改为按部门
    Details 折叠
  • 新增"实战工作流"区块，展示多智能体协作场景

影响范围

  • 不改动任何智能体 .md 文件，不影响现有用户
  • 新增文件不影响现有安装流程
  • install.sh 的改动是向后兼容的增强

测试

  • curl 安装已测试通过（macOS + Windows Git Bash）
  • install.sh --tool claude-code 正常工作
  • lint-agents.sh 覆盖全部 186 个智能体

Yhazrin and others added 8 commits March 22, 2026 20:24
@Yhazrin @claude
优化上手体验：一键安装、文档重组、搜索脚本
78d4aaa 
- 新增 setup.sh：curl 一行命令自动检测工具、转换、安装
- 新增 guide.html：安装后 Web 引导页（深色/浅色自适应）
- 新增 docs/QUICKSTART.md：3 条路径快速上手
- 新增 docs/TOOLS-GUIDE.md：各工具详细安装说明
- 新增 scripts/search-agents.sh：按关键词搜索 180 个智能体
- 新增 examples/：代码审查工作流示例
- 精简 README.md（696→288 行），折叠智能体总览表格
- 修复 lint-agents.sh 缺少 6 个部门目录的 bug
- 修改 install.sh：找不到 integrations/ 时自动调用 convert.sh
- 修改 .gitignore：允许 integrations/ 目录提交

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Yhazrin @claude
新增进阶功能：多智能体工作流、同步脚本、智能体创建向导
dc63aef 
- 新增 workflows/：产品上线、代码审查、营销活动 3 个多智能体协作模板
- 新增 scripts/sync-upstream.sh：自动同步上游仓库新增智能体
- 新增 scripts/create-agent.sh：交互式智能体创建向导

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Yhazrin @claude
perf: 优化 setup.sh — 跳过不需要的格式转换，修复临时目录清理
b536f67 
- 检测已安装工具后，只对需要 integrations/ 的工具运行 convert.sh
- Claude Code 和 Copilot 直接复制源 .md，无需转换
- EXIT trap 先 cd 出临时目录再删除，避免 Windows/Git Bash 文件锁

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Yhazrin @claude
fix: 静默处理 Windows 下临时目录清理失败
9c67c58 
Git Bash 在 Windows 上偶尔无法立即释放文件句柄，
导致 rm -rf 临时目录失败。加 2>/dev/null || true 避免
无害的清理错误影响安装脚本的退出码。

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Yhazrin
Update README.md
9b4a588
@Yhazrin @claude
docs: 重写 README，体现 fork 特色功能
184ca19 
- 标题改为 agency-agents-yhz，去掉 upstream 的语言切换链接
- badges 指向 Yhazrin/agency-agents-yhz
- 新增"这个 fork 做了什么"区块，突出一键安装、工作流、搜索脚本等
- 实战工作流区块展示 5 个预定义协作流程
- 实用脚本区块列出全部 7 个脚本及其用途
- 智能体列表精简为按部门折叠，非工程部用一行概括
- 控制在 ~200 行，新用户 2 分钟抓住重点

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@Yhazrin
Merge branch 'jnMetaCode:main' into main
710aef8
@Yhazrin
Merge branch 'main' into main
ad810ea
@jnMetaCode
Copy link
Copy Markdown
Owner

jnMetaCode commented Mar 24, 2026

感谢你花时间做了这么多工作！上手体验的优化方向很好，但这个 PR 有几个问题需要解决：

需要修改的：

  1. 项目名不能改成 agency-agents-yhz，badge 链接也不能指向 fork — 这是上游项目，不是个人 fork
  2. README.md 删掉了太多内容（693 行 → 95 行），QQ 群、agency-orchestrator、OpenClaw 说明、14 种工具列表等都丢了
  3. 工具数从 14 降到了 12，漏了 DeerFlow 和 Kiro

有价值的部分：

  • ✅ docs/QUICKSTART.md、TOOLS-GUIDE.md、CHEATSHEET.md — 文档拆分思路很好
  • ✅ scripts/search-agents.sh — 搜索脚本实用
  • ✅ scripts/sync-upstream.sh — 上游同步有价值
  • ✅ scripts/lint-agents.sh 补全缺失目录
  • ✅ workflows/ 工作流模板概念不错

建议拆分成小 PR：

  1. PR-A: docs/ 文档拆分（QUICKSTART + TOOLS-GUIDE + CHEATSHEET），不大改 README 主体，只在 README 里加链接指向这些文档
  2. PR-B: 实用脚本（search-agents.sh + sync-upstream.sh + lint 修复）
  3. PR-C: workflows/ 工作流模板
  4. PR-D: guide.html Web 引导页（可选）

这样每个 PR 都小而聚焦，更容易 review 和合并。期待你的拆分版本！

@jnMetaCode
Copy link
Copy Markdown
Owner

jnMetaCode commented Mar 26, 2026

感谢这个 PR！提升新用户上手体验的方向非常对，能看出花了不少心思。不过有几个问题需要先解决：

需要修复的问题

1. 仓库名被改了（阻塞合并）

PR 里把项目名从 agency-agents-zh 全局替换成了 agency-agents-yhz，链接也指向了 Yhazrin/agency-agents-yhz。这个需要全部改回来——README 标题、badge 链接、curl 安装地址、guide.html 里的引用等。

2. 有合并冲突

当前和 main 有冲突，需要 rebase 到最新的 main 分支解决一下。

3. 建议拆分 PR

这个 PR 一次做了太多事情（一键安装、文档拆分、工作流模板、搜索脚本、guide.html 等），review 起来比较吃力。建议拆成 2-3 个独立的 PR，例如：

  • PR A：文档重组（README 精简 + docs/ 拆分）
  • PR B：安装体验优化（setup.sh + install.sh 改进）
  • PR C：工作流模板 + 实用脚本

这样每个 PR 职责单一，review 更快，也更容易合并。

4. curl | bash 安全性

一键 curl 安装是个好想法，但建议在文档里同时提供 clone 后本地执行的方式作为替代，让用户可以先审查脚本内容。

以上问题里，第 1 点（仓库名）是必须修复的，其余是建议。修复后我们尽快 review 合并 👍

@Yhazrin
Copy link
Copy Markdown
Author

Yhazrin commented Mar 28, 2026 via email

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.

2 participants

@Yhazrin @jnMetaCode