docs: 把废弃声明同步到 AGENTS.md / docs/BACKGROUND.md / 文档站(README 已由 #2 覆盖)

オープン 初心者向け
#3 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
72/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
活発
技術スタック
javascript
領域
documentation

調査の方向性

AGENTS.md、docs/BACKGROUND.md、docs-site/index.md、docs-site/guide/introduction.md で提案されている箇所を読みます。issue には、それぞれに記載する警告とステータスの更新が指定されています。表現に一貫性を持たせるため、#2 の README にある既存の文言を確認します。4 か所すべてでプロジェクトが非推奨であることを明確に示し、読者を Plaita に案内できれば完了です。指定されたドキュメントのみという範囲を守ってください。

索引モデルが issue の本文から書いたものです。

説明

优先级 P2 · 依赖:无

基线 HEAD = d2e96d0

Summary

本仓已废弃(停止演进,编排能力迁移到 Plaita)。README 顶部的废弃声明已在 #2 提出(该 PR 只改 README);但仓内其它入口仍按「现役框架」呈现,读者从侧门进来会看不到废弃事实:

  • AGENTS.md:124 — 「当前里程碑: {待人工填写}」:占位符长期未填,且完全没有废弃提示;而该文件自称「AI / 开发者进入仓库的唯一导航契约」
  • AGENTS.md:3-9 — 顶部描述仍把 flowcast 讲成现役框架,无废弃提示
  • docs/BACKGROUND.md:1-5 — 以「项目背景与愿景(flowcast 为什么是现在这样)」开头,未说明这是历史愿景
  • docs-site/index.md:1-47 — 文档站首页 hero(text: 轻量 workflow 编排框架、tagline: 断点续跑 · HITL · 多 CLI/agent 调度 · …)无任何废弃信号
  • docs-site/guide/introduction.md:1-3 — 「介绍」页直接按现役框架介绍

影响

  • 文档站是外部读者的第一入口(https://jeffkit.github.io/flowcast/),目前完全没有废弃信号,会持续吸引新用户入坑。
  • AGENTS.md 是 AI 进仓的唯一导航契约;{待人工填写} 的里程碑会让 AI 误判本仓仍在演进,从而在废弃项目上继续投入。

建议

把 #2 的同一口径补到上述位置,建议措辞(可直接复用):

⚠️ 本项目已废弃(Deprecated)——请改用 Plaita:https://github.com/jeffkit/plaita
flowcast 已停止演进,编排能力已迁移到 Plaita。新项目请直接采用 Plaita;本仓与 npm 包仅作存量回退参考,不再接受新功能。

具体位置:AGENTS.md 顶部加废弃块 + 「当前状态」由占位符改为废弃说明与迁移指引(并注明该文件描述的是历史架构,用于读懂存量代码);docs/BACKGROUND.md 顶部前置一句「本文是历史愿景与路线图,含未完成项,不再代表未来方向」;docs-site/index.md 在 frontmatter 之后加 ::: warning 块;docs-site/guide/introduction.md 开头同样加 warning。

边界

  • 仅文档,不动任何代码;不动 FLOWX_* 兼容开关、package.json、npm 元数据。
  • npm deprecate flowcast@* "已废弃,请改用 Plaita:…" 属发布动作,不在本单范围(若要覆盖 npm install 用户需单独执行)。
  • AGENTS.md 的「模块地图」等技术内容保持原样(它准确描述了存量代码,只是不再是推荐用法)。
主要言語
JavaScript
スター
3
フォーク
1
PR マージ指標
30日以内にマージされた PR はありません

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

似ている issue

JavaScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。