docs(readme): present Windup product and MS3 focus - #93
Open
huyanxius wants to merge 8 commits into
Open
Conversation
Replace the placeholder README with the product positioning, production flow, core objects, current stage, local development, and documentation links. Reuse the existing Windup bird mark as the repository header artwork. Clarify shipped main-branch scope versus in-progress integration and delivery.
The repository landing page should show live project health without collecting decorative badges. Add main-branch frontend CI, backend CI, and license badges with issue and contributor links. Visitors can verify checks, ask for help, and find project contributors from the README.
Public repository navigation should remain understandable to both Chinese and English readers. Translate every second-level heading with a consistent Chinese / English pattern. GitHub's generated outline now exposes the same bilingual structure throughout the README.
The landing page should keep attention on the product instead of build metadata. Remove the frontend CI, backend CI, and license badge row from the header. The header now contains only the brand mark, product positioning, and core statement.
The repository introduction had internal validation language that interrupted the product narrative. Rewrite product, status, workflow, and contribution copy as direct reader-facing statements. Progress remains accurate while the README reads as a public product page.
The project has moved beyond the milestone named in the repository overview. Replace the stale MS2 reference with the current MS3 development stage. The README now reflects the milestone confirmed by the project team.
MS2 delivered the product MVP, so the README should no longer frame the current work as assembling a demo. Recast MS3 around extending existing characters through a constrained workflow, local reruns, and persistent runs. Align the product flow and editor description with the current milestone decisions.
|
The latest updates on your projects. Learn more about Vercel for GitHub. |
![fennoai[bot]](https://avatars.githubusercontent.com/in/1924301?s=60&v=4){kind=small}
The README currently presents Node.js 24 as the only supported frontend runtime. Document the dependency-supported ranges and keep Node.js 24 as the CI runtime. Contributors can distinguish supported local runtimes from the version used by CI.
huyanxius
requested review from
johnnyzhang-eng,
minorcell,
nighca,
xiaocheny214 and
xyh202131
August 3, 2026 13:05
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
改动说明
README 渲染预览
Windup
面向国产小游戏开发者的 2D 角色动态素材生成与资产工作台
交付的是资产，而不是图片。
查看完整 README 渲染效果
实现方式
验证
git diff --check：通过cd frontend && npm ci && npm run format:check && npm run lint && npm run typecheck && npm run test && npm run build：通过cd backend && uv sync --frozen && uv run ruff check . && uv run lint-imports && uv run pytest -q：通过关联