Skip to content

干净环境完整跑一次 Quick Start 并修订文档 #27

@keting

Description

@keting

Problem

README.md:127-141 已有 Quick Start 文本,但 CI 的 Docker job 仅验证 docker compose config / build没有覆盖 docker compose up + 登录 + 跑通最小闭环。当前没有"在干净环境完整跑通"的真实证据,新用户首次试用时容易踩到不被 CI 捕获的坑。

Proposed Change

  • 在干净环境(新 VM 或新 docker host)按照 README 一步步走
  • 完成最小闭环(验收项):
    • docker compose up 成功启动
    • 首次登录成功
    • 新建一个项目
    • 生成 Plan
    • 派发一个任务并跑通到完成状态
  • 全程记录踩坑点(环境变量、依赖、端口冲突、首次登录账号等)
  • 事后回写 README.md / src/README.md / docs/

Why It Matters

对早期开源项目,"真实可跑通"比"多写几页说明"更重要。这件事的过程会暴露真 bug 和文档错漏,是发 v0.1.0 release 前的关键校验。

Additional Context

  • 派生: 跑出来的真 bug → 单独开 type:bug issue;文案/步骤错漏 → 单独开 type:maintenance 文档 issue
  • 执行约束: 必须人工真跑;AI 仅承担事后 README 文案修订
  • 协同: 与 URL 校验 issue ([项目管理] Git 仓库地址有效性校验与错误提示 #22) 强相关,新用户最容易在"建项目填仓库"踩到

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:docsDocumentation, guides, and contributor docsstatus:readyTriaged and ready to pick uptype:maintenanceRefactor, tooling, chores, or non-user-facing upkeep

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions