Skip to content

docs: 清理与去重文档集 - #44

Merged
wangzhizhou merged 1 commit into
mainfrom
docs/prune
Nov 10, 2026
Merged

wangzhizhou merged 1 commit into
mainfrom
docs/prune

Conversation

@wangzhizhou

Copy link
Copy Markdown
Contributor

删除

  • docs/realtime.md(152 行):2/3 是未落地方案(Cloudflare Worker、自建 webhook 接收端);仍有效的平台约束已完整存在于 other-orgs.md 的「平台限制速查」。轮询说明留在 ghapp-scan.yml 注释里。

合并 / 修正

  • CHANGELOG:Unreleased 原有 12 个 ### Added (x) 块、内容重复、测试数量写了三个不同数字 → 整理为 Added / Changed / Fixed / Verified(159 → 101 行)。
  • README:删掉与 usage.md 重复的「30 秒快速上手」三段命令,改为模式选型表 + 指路;修正验证命令优先级(画像优先);retry 指向 ai-decide;删掉重复 layout 条目与 realtime 引用。
  • ai-workflow.md:§10 操作手册原本是 usage.md 的副本(两处会漂移)→ 改为指路;实现清单补 providers / profile / prompt / dispatcher / git。
  • other-orgs.md:App 创建改用 scripts/ghapp-manifest.mjs(用户自有的私有 App 无法装到组织);EASYGH_ORG → EASYGH_ORGS;artifact 名 ai-issue-<n>;验证配置优先级;删除 EasyBot 的旧计时数据。
  • portability.md / AGENTS.md / agents.md:AI_LOCALE 已实现(不再是"以后再加");"no automated test suite" 与事实不符;脚本清单补全。

校验

相对链接全部可达;npm run check 93 测试全绿;actionlint 通过。

- delete docs/realtime.md: two thirds of it were unbuilt roadmap (Cloudflare
  Worker, self-hosted webhook receiver) and the still-valid platform
  constraints are already listed in docs/other-orgs.md. Node stays as a
  one-line note in ghapp-scan.yml.
- CHANGELOG: the Unreleased section had 12 "### Added (x)" blocks with
  duplicated entries and three different test counts; consolidated into
  Added / Changed / Fixed / Verified (159 -> 101 lines).
- README: drop the duplicated per-mode quick-start (usage.md owns it), fix the
  verify-config precedence (profile first), point retry at ai-decide, remove
  the duplicated layout entry and the stale realtime reference.
- ai-workflow.md: §10 was a copy of usage.md's operator table (two sources of
  truth that drift); it now points at usage.md, and the implementation table
  covers providers/profile/prompt/dispatcher/git.
- other-orgs.md: App creation via scripts/ghapp-manifest.mjs (a user-owned
  private App cannot install on an org), EASYGH_ORG -> EASYGH_ORGS, artifact
  name `ai-issue-<n>`, verify config precedence, drop the stale EasyBot timing
  anecdote.
- portability.md / AGENTS.md / agents.md: AI_LOCALE is implemented (no longer
  "add it later"), "no automated test suite" was wrong, script list completed.
@wangzhizhou
wangzhizhou merged commit 94f7c2a into main Nov 10, 2026
2 checks passed
@wangzhizhou
wangzhizhou deleted the docs/prune branch November 10, 2026 13:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant