Skip to content

docs(readme): document the v1.0 project handoff - #929

Merged
minorcell merged 1 commit into
1024XEngineer:mainfrom
huyanxius:docs/final-readme
Aug 29, 2026
Merged

docs(readme): document the v1.0 project handoff#929
minorcell merged 1 commit into
1024XEngineer:mainfrom
huyanxius:docs/final-readme

Conversation

@huyanxius

@huyanxius huyanxius commented Aug 29, 2026

Copy link
Copy Markdown
Collaborator

Windup 已完成 v1.0 结项交付。本 PR 将根 README 从上线初期说明收束为最终交付说明,并校正已经变化的本地启动与仓库结构信息。

Why

现有 README 没有记录 v1.0.0,仍把多方向资产与三渲二写成“推进中”;其中的数据层启动命令也已经随着 Compose 拆分失效。继续保留这些内容会让访客低估最终交付,也会让贡献者按错误路径启动项目。

Changes

  • 保留原有品牌首屏、口号、角色旅程与宣传主线,只补充结项事实并修正过期内容。
  • 标明 v1.0 结项状态,按当前 main 更新最终能力与产品链路。
  • 补充多方向资产、可选三渲二、像素网格重建、Playtest、完整导出与 Cocos Creator 3.8.x 一键导入。
  • 更新核心对象、技术栈、仓库结构与相关文档入口。
  • 修正数据层 Compose、Worker 和 VITE_API_BASE_URL 的本地开发说明。

Verification

  • git diff --check:通过。
  • GitHub Markdown API 渲染:通过,结项状态、能力表格与本地图片均正常输出。
  • GitHub 风格本地预览:首屏、能力表格与产品链路完成视觉检查;7 张图片全部加载,控制台无错误或警告。
  • docker compose --env-file .env.db.example -f docker-compose.db.yml config --services:通过,解析出 postgresredis
  • cd backend && uv run python -m pytest -q ../tests/test_version_gate.py:24 passed。
  • python3 scripts/version_gate.py check VERSION --previous "$(git show upstream/main:VERSION)"VERSION 未变更且格式合法。
  • gh release view v1.0.0 --repo 1024XEngineer/Windup:确认 Release 已于 2026-08-28 发布。
  • curl 检查 https://windup.xinhttps://windup.xin/guide:均返回 HTTP 200。
  • GitHub Actions Frontend checksBackend CI / lint-and-test:全部通过。

Scope

  • 本 PR 仅修改根 README.md,不包含产品行为、接口、部署或 Release 正文变更。
  • 本 PR 不重写原有品牌叙事,也不加入仍含占位内容的旧截图。
  • 本次没有可见 UI 改动,因此不提供浏览器截图。

Related Issues

Closes #927
Refs #896
Refs #364

Windup has completed its v1.0 project delivery, while the root README still describes several shipped capabilities as work in progress.

Record the final capability boundary, release link, workflow, and current toolchain, and correct the split data-service and worker startup instructions.

Visitors can understand the delivered product and contributors can follow commands that match the final repository layout.
@vercel

vercel Bot commented Aug 29, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

1 Skipped Deployment
Project Deployment Actions Updated (UTC)
windup Ignored Ignored Preview Aug 29, 2026 3:40am

@codecov

codecov Bot commented Aug 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #929      +/-   ##
==========================================
+ Coverage   86.12%   91.27%   +5.14%     
==========================================
  Files         306      193     -113     
  Lines       24037    13204   -10833     
  Branches     3646        0    -3646     
==========================================
- Hits        20703    12052    -8651     
+ Misses       2360     1152    -1208     
+ Partials      974        0     -974     
Flag Coverage Δ
backend 91.27% <ø> (ø)
frontend ?

Flags with carried forward coverage won't be shown. Click here to find out more.
see 113 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@fennoai fennoai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

已检查本 PR 的完整 README.md 变更,重点核对了本地开发命令、Compose 配置、Worker 入口和新增文档链接。除下方本地 Redis 配置问题外,Worker 入口和新增仓库内链接均存在,git diff --check 通过;本环境的 Docker 客户端不支持 docker compose --env-file,因此未能执行 Compose 配置解析。

Comment thread README.md
@minorcell
minorcell merged commit cb66342 into 1024XEngineer:main Aug 29, 2026
12 checks passed
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.

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

2 participants