docs: improve README and add comprehensive developer documentation#39
Open
alanwhy wants to merge 3 commits into
Open
docs: improve README and add comprehensive developer documentation#39alanwhy wants to merge 3 commits into
alanwhy wants to merge 3 commits into
Conversation
added 3 commits
May 22, 2026 16:09
- Add badges (npm version, license, WebGPU, TypeScript) - Add Features, Requirements, Installation, Quick Start sections - Add Development commands and Documentation table - Add Examples table and Contributing/License sections - Add language switcher linking to README.zh-CN.md
- Full Chinese translation of README.md - Add bidirectional language switcher (English | 中文)
- README.md: project overview, quick start, core concepts - ARCHITECTURE.md: system design with Mermaid diagrams - API.md: full public API reference - DEVELOPMENT.md: local setup, build flow, contribution guide - DEPLOYMENT.md: build output and npm publish workflow - CONTRIBUTING.md: PR conventions and code standards
There was a problem hiding this comment.
Pull request overview
This PR revamps the repository’s documentation for both users and contributors by rewriting the main README, adding a Chinese README, and introducing an ai-docs/ developer documentation suite.
Changes:
- Rewrites
README.mdinto a fuller open-source style README (features, install, quick start, dev commands, docs/examples tables). - Adds
README.zh-CN.mdwith a translated README and bidirectional language switching. - Adds
ai-docs/documentation set covering architecture, API reference, development, deployment, and contributing.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 19 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | New public-facing README with badges, quick start, and links into ai-docs/. |
| README.zh-CN.md | Chinese README translation mirroring the English README structure. |
| ai-docs/README.md | Developer-docs entry point with overview, quick start, and concept map. |
| ai-docs/ARCHITECTURE.md | Architecture write-up with Mermaid diagrams and subsystem descriptions. |
| ai-docs/API.md | Large API reference document for engine public surface area. |
| ai-docs/DEVELOPMENT.md | Local dev/setup and contribution workflow guidance. |
| ai-docs/DEPLOYMENT.md | Build artifact + publish workflow documentation. |
| ai-docs/CONTRIBUTING.md | Contribution standards, PR checklist, and conventions. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| <img src="https://img.shields.io/github/license/hpugis/GEngine" alt="license" /> | ||
| </a> | ||
| <img src="https://img.shields.io/badge/WebGPU-required-blue" alt="WebGPU required" /> | ||
| <img src="https://img.shields.io/badge/TypeScript-5+-3178c6?logo=typescript&logoColor=white" alt="TypeScript" /> |
| ## License | ||
|
|
||
| scene.add(pointLight); | ||
| [MIT](./LICENSE) |
| <img src="https://img.shields.io/github/license/hpugis/GEngine" alt="开源协议" /> | ||
| </a> | ||
| <img src="https://img.shields.io/badge/WebGPU-required-blue" alt="需要 WebGPU" /> | ||
| <img src="https://img.shields.io/badge/TypeScript-5+-3178c6?logo=typescript&logoColor=white" alt="TypeScript" /> |
|
|
||
| ## 开源协议 | ||
|
|
||
| [MIT](./LICENSE) |
|
|
||
| ### TypeScript | ||
|
|
||
| - 使用 `strict: true` 模式（已在 `tsconfig.json` 配置） |
Comment on lines
+540
to
+551
| ### CubeTextureLoader | ||
|
|
||
| **文件**：[src/loader/CubeTextureLoader.ts](../src/loader/CubeTextureLoader.ts) | ||
|
|
||
| ```typescript | ||
| const loader = new CubeTextureLoader(); | ||
| const cubeTexture = await loader.loadCubeTexture([ | ||
| "px.jpg", "nx.jpg", // +X, -X | ||
| "py.jpg", "ny.jpg", // +Y, -Y | ||
| "pz.jpg", "nz.jpg" // +Z, -Z | ||
| ]); | ||
| ``` |
Comment on lines
+338
to
+343
| RenderObject <|-- Mesh | ||
| Mesh <|-- Node | ||
| Mesh <|-- SkyBox | ||
| Mesh <|-- InstanceMesh | ||
| Mesh <|-- Sprite | ||
| Mesh <|-- Points |
Comment on lines
+504
to
+507
| Color.fromHex("#ff8800") | ||
|
|
||
| // 输出 | ||
| c.toHex() |
Comment on lines
+511
to
+517
| ### Euler | ||
|
|
||
| ```typescript | ||
| const e = new Euler(x, y, z, order); | ||
| // order: "XYZ" | "YXZ" | "ZXY" 等 | ||
| ``` | ||
|
|
| | `camera` | `PerspectiveCamera` | 当前主相机 | | ||
| | `context` | `Context` | WebGPU 上下文 | | ||
| | `frameState` | `FrameState` | 当前帧状态 | | ||
| | `background` | `Color \| Texture` | 背景颜色或天空盒纹理 | |
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
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.
Summary
Improves the repository's public-facing documentation and adds a full developer documentation suite.
Changes
README.md— Rewritten in open-source community styleREADME.zh-CN.mdREADME.zh-CN.md— New Chinese READMEREADME.mdEnglish | 中文)ai-docs/— New developer documentation suiteREADME.mdARCHITECTURE.mdAPI.mdDEVELOPMENT.mdDEPLOYMENT.mdCONTRIBUTING.mdChecklist