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

Đang mở Phù hợp với người mới
#3 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
72/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
javascript
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc các vị trí được đề xuất trong AGENTS.md, docs/BACKGROUND.md, docs-site/index.md và docs-site/guide/introduction.md; issue nêu rõ cảnh báo và các cập nhật trạng thái cho từng vị trí. Kiểm tra cách diễn đạt hiện có trong README của #2 để dùng từ nhất quán. Hoàn tất khi cả bốn vị trí đều nêu rõ dự án đã lỗi thời và hướng người đọc đến Plaita, đồng thời giữ đúng phạm vi chỉ thay đổi tài liệu đã nêu.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

优先级 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 的「模块地图」等技术内容保持原样(它准确描述了存量代码,只是不再是推荐用法)。
Ngôn ngữ chính
JavaScript
Star
3
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.