@routerhub/agent-rules 1.5.167 → 1.5.168

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/AGENTS.base.md CHANGED
@@ -524,6 +524,11 @@
524
524
  - ⚠️ **文档正文存放到本项目对应的私有 GitHub 仓库 `<项目>-docs`**(如 `PomexAITeam/pomexai-docs`),仓库名由 git remote 推导:`git@github.com:PomexAITeam/pomexai.git` → 组织 `PomexAITeam`、项目 `pomexai` → 文档仓库 `PomexAITeam/pomexai-docs`。**私有仓库 = 仅团队成员登录后可查看**,天然满足「文档只给团队看」。
525
525
  - 新建文档使用 `/create-doc` skill:纯文字/表格类 → 直接写 MD 直传;截图版报告 → 生成 HTML → 无头 Chrome 转 PDF → push 到 `<项目>-docs` 私有仓库的 `docs` 分支 → 在代码仓库 `docs/index.html` 记录「文档名 | 链接」。
526
526
  - 文档链接格式:`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.<pdf|md>`,粘贴到浏览器即可查看(GitHub 内嵌渲染 PDF / Markdown;私有仓库未登录会跳登录页)。
527
+ - ⚠️ **迁移项目既有文档到 `<项目>-docs` 前,先区分「纯文档」与「代码资产 / 对外服务页面」,禁止一刀切全迁**:
528
+ - **对外服务的 API 文档站**(gateway 类项目的 `docs/`:含 `index.html` + `authentication.html` + `css/` + `js/` + `nginx.conf.template` 的整套站点)是**线上产品页面**,随模型/接口持续更新(git log 常有「添加 xxx 模型」等提交),线上 URL 可访问(如 `https://xxx/docs` 返回 200)——这类**不能迁**,迁走线上直接 404。判断标准:线上有对应 URL 且能访问 → 是对外服务页面,不是内部文档。
529
+ - **散落文档目录**(`inter_docs/`、`local_docs/`、`design_docs/`、`internal/xxx/docs/`)里常**混着代码**:需求/设计/测试说明(.md)旁边就有集成测试脚本(.sh)、用例(.sql/.json)、env 模板、甚至被 Go 代码运行时引用的路径(如 `filepath.Join(repoRoot, "inter_docs", ...)`)。迁移前必须逐目录核对:**纯 .md 文档 → 迁;.sh/.sql/.json/.env 及被代码引用的路径 → 必须留在原位**,禁止连脚本一起搬走(搬走就破坏测试链路和运行时)。
530
+ - **类比:搬书房前先分清楚「书」和「记账本」**——书(纯文档)搬进藏书库(-docs 仓库),记账本(测试脚本/被引用的配置)得留在桌上随时用;把记账本也塞进藏书库,下次算账(跑测试)就找不到本子了。
531
+ - 核对方法:迁移前 `grep -rn "目录名"` 搜代码/CI/脚本,确认哪些路径被引用;被引用的保留,未被引用的纯文档才迁。
527
532
 
528
533
  ## 文档/文件链接交付
529
534
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@routerhub/agent-rules",
3
- "version": "1.5.167",
3
+ "version": "1.5.168",
4
4
  "description": "Shared Copilot agent rules and guidelines for RouterHub projects",
5
5
  "main": "AGENTS.base.md",
6
6
  "bin": {
package/rules/global.md CHANGED
@@ -524,6 +524,11 @@ name: "通用规则"
524
524
  - ⚠️ **文档正文存放到本项目对应的私有 GitHub 仓库 `<项目>-docs`**(如 `PomexAITeam/pomexai-docs`),仓库名由 git remote 推导:`git@github.com:PomexAITeam/pomexai.git` → 组织 `PomexAITeam`、项目 `pomexai` → 文档仓库 `PomexAITeam/pomexai-docs`。**私有仓库 = 仅团队成员登录后可查看**,天然满足「文档只给团队看」。
525
525
  - 新建文档使用 `/create-doc` skill:纯文字/表格类 → 直接写 MD 直传;截图版报告 → 生成 HTML → 无头 Chrome 转 PDF → push 到 `<项目>-docs` 私有仓库的 `docs` 分支 → 在代码仓库 `docs/index.html` 记录「文档名 | 链接」。
526
526
  - 文档链接格式:`https://github.com/<ORG>/<项目>-docs/blob/docs/<文件名>.<pdf|md>`,粘贴到浏览器即可查看(GitHub 内嵌渲染 PDF / Markdown;私有仓库未登录会跳登录页)。
527
+ - ⚠️ **迁移项目既有文档到 `<项目>-docs` 前,先区分「纯文档」与「代码资产 / 对外服务页面」,禁止一刀切全迁**:
528
+ - **对外服务的 API 文档站**(gateway 类项目的 `docs/`:含 `index.html` + `authentication.html` + `css/` + `js/` + `nginx.conf.template` 的整套站点)是**线上产品页面**,随模型/接口持续更新(git log 常有「添加 xxx 模型」等提交),线上 URL 可访问(如 `https://xxx/docs` 返回 200)——这类**不能迁**,迁走线上直接 404。判断标准:线上有对应 URL 且能访问 → 是对外服务页面,不是内部文档。
529
+ - **散落文档目录**(`inter_docs/`、`local_docs/`、`design_docs/`、`internal/xxx/docs/`)里常**混着代码**:需求/设计/测试说明(.md)旁边就有集成测试脚本(.sh)、用例(.sql/.json)、env 模板、甚至被 Go 代码运行时引用的路径(如 `filepath.Join(repoRoot, "inter_docs", ...)`)。迁移前必须逐目录核对:**纯 .md 文档 → 迁;.sh/.sql/.json/.env 及被代码引用的路径 → 必须留在原位**,禁止连脚本一起搬走(搬走就破坏测试链路和运行时)。
530
+ - **类比:搬书房前先分清楚「书」和「记账本」**——书(纯文档)搬进藏书库(-docs 仓库),记账本(测试脚本/被引用的配置)得留在桌上随时用;把记账本也塞进藏书库,下次算账(跑测试)就找不到本子了。
531
+ - 核对方法:迁移前 `grep -rn "目录名"` 搜代码/CI/脚本,确认哪些路径被引用;被引用的保留,未被引用的纯文档才迁。
527
532
 
528
533
  ## 文档/文件链接交付
529
534