Skip to content

[Documentation]: Finalize the root README for v1.0 handoff #927

Description

@huyanxius

Problem

根 README 仍停留在上线初期:把已经进入主线的多方向资产与三渲二写成“推进中”,也没有记录 v1.0.0 结项版本。与此同时,本地开发说明仍尝试从应用层 Compose 启动已经拆出的 PostgreSQL 与 Redis,并漏掉 Worker 和前端 API 地址。

Goal

把根 README 收束为项目结项说明,让访客能准确理解最终交付,让贡献者按当前仓库结构启动和验证项目。

Scope

  • 保留现有品牌首屏、口号、角色旅程与宣传主线,只补充事实和修正错误。
  • 标明 v1.0.0 结项版本与在线、开源入口。
  • 按当前 main 更新 Quick Start、Workflow Editor、多方向资产、三渲二、Playtest、导出与 Cocos Creator 导入能力。
  • 更新产品链路、核心对象、技术栈和仓库结构。
  • 修正数据层 Compose、Worker 与 VITE_API_BASE_URL 的本地开发说明。
  • 补充结项版本、使用手册、Cocos 导入器和像素网格重建器文档入口。

Acceptance Criteria

  • README 明确 v1.0.0 是结项交付版本基线。
  • 原有首屏视觉、品牌口号和宣传叙事保持不变。
  • 已交付能力与当前主线实现一致,不把可选部署能力写成所有实例默认启用。
  • 本地开发说明使用 docker-compose.db.yml 启动数据层,并包含后端、Worker 与前端三个进程。
  • 仓库结构与质量检查覆盖当前的 frontend、backend、native 和 Cocos 导入工具。
  • GitHub Markdown 渲染正常,新增的本地文件链接、Release 与在线手册入口有效。

Out of Scope

  • 不修改产品代码、接口契约、部署配置或 Release 正文。
  • 不重写既有品牌叙事,也不使用仍含占位内容的旧截图扩充版面。
  • 不承诺 Cocos Creator 3.9+ 或其他引擎的一键适配。

Refs #364

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions