Refactor: update engine and canvas doc #2529
Conversation
WalkthroughThis pull request focuses on improving the documentation for the canvas and engine components in both English and Chinese documentation files. The changes primarily involve rephrasing for clarity, removing brand-specific references, and updating code examples with new configuration options. The modifications aim to enhance readability and provide more precise explanations of functionality without altering the core technical details. Changes
Sequence DiagramsequenceDiagram
participant User
participant Engine
participant Canvas
User->>Engine: Create with configuration
Engine->>Canvas: Initialize canvas
Canvas-->>Engine: Canvas ready
Engine->>Engine: Configure options
Engine-->>User: Engine instance
Possibly related PRs
Suggested labels
Suggested reviewers
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
docs/zh/core/canvas.md (1)
Line range hint
40-47: Add error handling for invalid scale values.The
resizeByClientSizeexample should include validation for the scale parameter to prevent issues with negative or zero values.// 自定义像素比调整画布尺寸 +if (scale <= 0) { + throw new Error("Scale must be a positive number"); +} engine.canvas.resizeByClientSize(1.5);docs/en/core/canvas.md (2)
53-53: Fix markdown emphasis formatting.Use underscores instead of asterisks for emphasis to maintain consistency with the style guide.
-375 * 3 = *1125* +375 * 3 = _1125_🧰 Tools
🪛 Markdownlint (0.37.0)
53-53: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
53-53: Expected: underscore; Actual: asterisk
Emphasis style(MD049, emphasis-style)
72-80: Add error handling for scale calculation.The energy-saving mode example should validate the scale value to prevent potential issues.
const pixelRatio = window.devicePixelRatio; const scale = 3 / 2; + +// Validate scale +if (scale <= 0) { + throw new Error("Scale must be a positive number"); +} /** * Set energy-saving mode, defaults to full screen, but you can set any width and height */docs/zh/core/engine.md (1)
31-37: Fix table formatting issue.The table row for
canvashas an extra column which breaks the markdown formatting.-| canvas | 可以是画布 ID（ `string`） 或画布对象（`HTMLCanvasElement |OffscreenCanvas`）。 | +| canvas | 可以是画布 ID（ `string`） 或画布对象（`HTMLCanvasElement` 或 `OffscreenCanvas`）。 |🧰 Tools
🪛 Markdownlint (0.37.0)
33-33: Expected: 2; Actual: 3; Too many cells, extra data will be missing
Table column count(MD056, table-column-count)
docs/en/core/engine.md (2)
21-25: Add example values in the configuration object.The configuration example would be more helpful with sample values.
const engine = await WebGLEngine.create({ canvas: "canvas-id", - colorSpace: {...}, - graphicDeviceOptions: {...}, - gltf: {...}, - ktx2Loader: {...} + colorSpace: ColorSpace.Linear, + graphicDeviceOptions: { + webGLMode: "webgl2" + }, + gltf: { + meshOpt: { workerCount: 2 } + }, + ktx2Loader: { + workerCount: 2 + } });
37-37: Improve worker count description clarity.The description of worker count behavior can be more concise.
-If workerCount is greater than 0, worker threads will be created; if it equals 0, only the main thread will be used. +Uses worker threads when workerCount > 0, otherwise processes in the main thread.🧰 Tools
🪛 LanguageTool
[style] ~37-~37: This phrasing could be wordy, so try replacing it with something more concise.
Context: ... workerCount: number }`. If workerCount is greater than 0, worker threads will be created; if i...(MORE_THAN_EXCEEDS)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/en/core/canvas.md(3 hunks)docs/en/core/engine.md(1 hunks)docs/zh/core/canvas.md(3 hunks)docs/zh/core/engine.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/zh/core/engine.md
33-33: Expected: 2; Actual: 3; Too many cells, extra data will be missing
Table column count
(MD056, table-column-count)
docs/en/core/canvas.md
53-53: Expected: underscore; Actual: asterisk
Emphasis style
(MD049, emphasis-style)
53-53: Expected: underscore; Actual: asterisk
Emphasis style
(MD049, emphasis-style)
docs/en/core/engine.md
33-33: Expected: 2; Actual: 3; Too many cells, extra data will be missing
Table column count
(MD056, table-column-count)
🪛 LanguageTool
docs/en/core/engine.md
[style] ~37-~37: This phrasing could be wordy, so try replacing it with something more concise.
Context: ... workerCount: number }`. If workerCount is greater than 0, worker threads will be created; if i...
(MORE_THAN_EXCEEDS)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: build (22.x, windows-latest)
- GitHub Check: codecov
- GitHub Check: e2e (22.x)
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2529 +/- ##
==========================================
- Coverage 68.58% 68.58% -0.01%
==========================================
Files 957 957
Lines 100125 100125
Branches 8572 8568 -4
==========================================
- Hits 68671 68667 -4
- Misses 31198 31202 +4
Partials 256 256
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Please check if the PR fulfills these requirements
What kind of change does this PR introduce? (Bug fix, feature, docs update, ...)
What is the current behavior? (You can also link to an open issue here)
What is the new behavior (if this is a feature change)?
Does this PR introduce a breaking change? (What changes might users need to make in their application due to this PR?)
Other information:
Summary by CodeRabbit
Documentation
Technical Updates
WebGLEngine.create()method with additional configuration optionscolorSpace,gltf, andktx2Loaderparameters