Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add mini game doc #2503

Open
wants to merge 5 commits into
base: dev/1.4
Choose a base branch
from
Open

Conversation

singlecoder
Copy link
Member

@singlecoder singlecoder commented Jan 13, 2025

Summary by CodeRabbit

  • New Features

    • Added a new "platform" section to documentation.
    • Introduced multi-platform export documentation.
    • Added documentation for H5 and WeChat Mini Game platform exports.
  • Documentation

    • Updated multiple documentation links from /docs/assets/build/ to /docs/platform/platform/.
    • Reorganized export and deployment documentation structure.
    • Added comprehensive guides for platform-specific export configurations.
  • Chores

    • Removed docs/zh/assets/build.md file.
    • Updated navigation and reference links across documentation.

@singlecoder singlecoder added the documentation Improvements or additions to documentation label Jan 13, 2025
@singlecoder singlecoder added this to the 1.4 milestone Jan 13, 2025
@singlecoder singlecoder self-assigned this Jan 13, 2025
Copy link

coderabbitai bot commented Jan 13, 2025

Walkthrough

This pull request introduces a comprehensive documentation update for the Galacean platform, focusing on multi-platform export capabilities. The changes include adding a new "platform" section to the documentation structure, updating multiple links across various markdown files, and creating new documentation files for H5 and WeChat Mini Game platform exports. The modifications reflect a reorganization of export and deployment documentation, centralizing platform-specific export information under a new unified section.

Changes

File Change Summary
docs/zh/_meta.json, docs/en/_meta.json Added new "platform" section with collapse theme
docs/zh/art/digital-human.md, docs/zh/assets/overall.md, docs/zh/core/canvas.md, docs/zh/core/engine.md, docs/zh/graphics/2D/spine/editor.md, docs/zh/graphics/texture/2d.md, docs/zh/graphics/texture/compression.md Updated export/deployment links from /docs/assets/build/ to /docs/platform/platform/
docs/zh/assets/build.md File deleted
docs/zh/platform/h5.md, docs/en/platform/h5.md New documentation for H5 platform export
docs/zh/platform/platform.md, docs/en/platform/platform.md New overview section for multi-platform export
docs/zh/platform/wechatMiniGame.md, docs/en/platform/wechatMiniGame.md New documentation for WeChat Mini Game platform export

Sequence Diagram

sequenceDiagram
    participant Editor
    participant ExportPanel
    participant Platform
    participant ProjectConfig

    Editor->>ExportPanel: Open Export Panel
    ExportPanel->>Platform: Select Target Platform
    Platform->>ProjectConfig: Configure Export Settings
    ProjectConfig-->>Platform: Validate Configuration
    Platform->>Editor: Generate Exportable Project
    Editor->>Platform: Download/Export Project
Loading

Possibly related PRs

Suggested reviewers

  • MrKou47
  • cptbtptpbcptdtptp
  • eyworldwide

Poem

🐰 Hopping through docs with glee,
Platforms unfold, now easy to see!
From H5 to WeChat, exports take flight,
Documentation shining ever so bright!
A rabbit's guide to coding delight! 🚀


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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@singlecoder singlecoder changed the base branch from main to dev/1.4 January 13, 2025 12:24
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (5)
docs/zh/platform/h5.md (2)

22-22: Replace hard tabs with spaces.

For consistency in markdown files, replace hard tabs with spaces.

-│		├── scene.json # 场景文件
+│   ├── scene.json # 场景文件
🧰 Tools
🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)


16-16: Add alt text to images for accessibility.

Images should include descriptive alt text. For example:

-<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*jINgTIhAuDgAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*jINgTIhAuDgAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="H5 platform export panel" />

Also applies to: 50-50, 54-54

docs/zh/platform/wechatMiniGame.md (1)

14-21: Standardize table formatting.

For consistency:

  1. Use leading-only pipe style
  2. Add blank lines around tables

Example fix for the first table:

+
| 配置 | 描述 | 对应到微信小游戏的配置文件 | 对应到微信小游戏中的字段 |
| --- | --- | --- | --- |
| AppId | 微信小游戏的 AppId,必填,截图中的 wxdf8199565c509fb9 为测试账号 | project.config.json | appid |
+

Also applies to: 64-74

🧰 Tools
🪛 Markdownlint (0.37.0)

15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)

docs/zh/platform/platform.md (2)

8-8: Fix grammatical issue in Chinese text.

Correct the modifier usage:

-开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。
+开发者通过编辑器制作的项目,可以快速地导出到不同的平台所需的工程。
🧰 Tools
🪛 LanguageTool

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后,就可以...

(wb4)


18-18: Add alt text to images for accessibility.

Add descriptive alt text to images. For example:

-<img src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*U2RuQLwwNXIAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<img src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*U2RuQLwwNXIAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="Export button location in editor" />

Also applies to: 22-22, 26-26

🧰 Tools
🪛 Markdownlint (0.37.0)

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a8414f9 and 648e645.

📒 Files selected for processing (13)
  • docs/zh/_meta.json (1 hunks)
  • docs/zh/art/digital-human.md (1 hunks)
  • docs/zh/assets/build.md (0 hunks)
  • docs/zh/assets/overall.md (1 hunks)
  • docs/zh/core/canvas.md (1 hunks)
  • docs/zh/core/engine.md (1 hunks)
  • docs/zh/graphics/2D/spine/editor.md (1 hunks)
  • docs/zh/graphics/2D/spine/runtime.md (1 hunks)
  • docs/zh/graphics/texture/2d.md (1 hunks)
  • docs/zh/graphics/texture/compression.md (1 hunks)
  • docs/zh/platform/h5.md (1 hunks)
  • docs/zh/platform/platform.md (1 hunks)
  • docs/zh/platform/wechatMiniGame.md (1 hunks)
💤 Files with no reviewable changes (1)
  • docs/zh/assets/build.md
✅ Files skipped from review due to trivial changes (6)
  • docs/zh/graphics/2D/spine/editor.md
  • docs/zh/assets/overall.md
  • docs/zh/core/engine.md
  • docs/zh/graphics/2D/spine/runtime.md
  • docs/zh/graphics/texture/2d.md
  • docs/zh/graphics/texture/compression.md
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/zh/platform/h5.md

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

docs/zh/platform/wechatMiniGame.md

63-63: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


65-65: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


66-66: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


67-67: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


68-68: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


69-69: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


70-70: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


71-71: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


72-72: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


73-73: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


74-74: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: null
Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

docs/zh/platform/platform.md

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

🪛 LanguageTool
docs/zh/platform/platform.md

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后,就可以...

(wb4)

🔇 Additional comments (6)
docs/zh/_meta.json (1)

62-67: LGTM! Navigation structure is well organized.

The new "platform" section is logically placed and maintains consistency with other sections.

docs/zh/art/digital-human.md (1)

28-28: LGTM! Link updated correctly.

The link to the export documentation has been properly updated to reflect the new platform-specific documentation structure.

docs/zh/platform/h5.md (1)

1-64: LGTM! Comprehensive H5 export documentation.

The documentation thoroughly covers configuration, export process, debugging, and build instructions.

🧰 Tools
🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

docs/zh/platform/wechatMiniGame.md (1)

1-74: LGTM! Comprehensive WeChat Mini Game export documentation.

The documentation thoroughly covers platform-specific configurations, export process, debugging instructions, and directory structure explanation.

🧰 Tools
🪛 Markdownlint (0.37.0)

63-63: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


65-65: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


66-66: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


67-67: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


68-68: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


69-69: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


70-70: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


71-71: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


72-72: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


73-73: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


74-74: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: null
Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

docs/zh/platform/platform.md (1)

1-52: LGTM! Well-structured platform export overview.

The documentation provides a clear and comprehensive overview of the multi-platform export capabilities, including detailed configuration explanations and supported platforms.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后,就可以...

(wb4)

🪛 Markdownlint (0.37.0)

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/zh/core/canvas.md (1)

44-44: LGTM! Verify the new documentation link.

The documentation update correctly reflects the reorganization of export configuration under the new platform section.

Let's verify that the new documentation path exists and is accessible:

✅ Verification successful

Documentation link verified and correctly structured

The new platform documentation exists at the expected location and is consistently referenced across the documentation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the existence of the new platform documentation

# Check if the new platform documentation exists
fd -t f "platform.md" docs/zh/platform/

# Check for any broken internal links to /docs/platform/platform
rg -l "/docs/platform/platform" docs/

Length of output: 351

@GuoLei1990 GuoLei1990 changed the title Add mini doc Add mini game doc Jan 14, 2025
Copy link

codecov bot commented Jan 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 68.51%. Comparing base (a8414f9) to head (a639951).
Report is 3 commits behind head on dev/1.4.

Additional details and impacted files
@@             Coverage Diff             @@
##           dev/1.4    #2503      +/-   ##
===========================================
+ Coverage    68.50%   68.51%   +0.01%     
===========================================
  Files          956      957       +1     
  Lines       100007   100057      +50     
  Branches      8545     8551       +6     
===========================================
+ Hits         68506    68559      +53     
+ Misses       31245    31242       -3     
  Partials       256      256              
Flag Coverage Δ
unittests 68.51% <ø> (+0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 6

🧹 Nitpick comments (2)
docs/en/platform/wechatMiniGame.md (1)

63-74: Use proper heading instead of bold text.

The directory explanation section uses bold text instead of a proper heading level. Convert it to a heading for better document structure.

-**工程目录说明**
+### Project Directory Structure
🧰 Tools
🪛 Markdownlint (0.37.0)

63-63: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


64-64: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


65-65: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


66-66: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


67-67: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


68-68: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


69-69: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


70-70: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


71-71: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


72-72: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


73-73: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


74-74: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: null
Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

docs/en/platform/h5.md (1)

22-22: Replace hard tab with spaces in directory structure.

The directory structure uses a hard tab which should be replaced with spaces for consistent formatting.

-│		├── scene.json # 场景文件
+│   ├── scene.json # Scene file
🧰 Tools
🪛 Markdownlint (0.37.0)

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 648e645 and a639951.

📒 Files selected for processing (4)
  • docs/en/_meta.json (1 hunks)
  • docs/en/platform/h5.md (1 hunks)
  • docs/en/platform/platform.md (1 hunks)
  • docs/en/platform/wechatMiniGame.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
docs/en/platform/wechatMiniGame.md

63-63: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


15-15: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


16-16: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


17-17: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


18-18: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


19-19: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


20-20: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


21-21: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


65-65: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


66-66: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


67-67: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


68-68: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


69-69: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


70-70: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


71-71: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


72-72: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


73-73: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


74-74: Expected: leading_only; Actual: leading_and_trailing; Unexpected trailing pipe
Table pipe style

(MD055, table-pipe-style)


64-64: null
Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

docs/en/platform/platform.md

18-18: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


22-22: null
Images should have alternate text (alt text)

(MD045, no-alt-text)


26-26: null
Images should have alternate text (alt text)

(MD045, no-alt-text)

docs/en/platform/h5.md

22-22: Column: 2
Hard tabs

(MD010, no-hard-tabs)

🪛 LanguageTool
docs/en/platform/platform.md

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后,就可以...

(wb4)

⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: build (22.x, windows-latest)
  • GitHub Check: e2e (22.x)
  • GitHub Check: codecov
🔇 Additional comments (1)
docs/en/_meta.json (1)

62-67: LGTM! The new platform section follows the established pattern.

The addition maintains consistency with other sections in terms of structure and formatting, while logically organizing platform-specific documentation content.


在导出到微信小游戏平台的时候,有以下这些配置项:

<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" />
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add alt text to images for accessibility.

Images should include descriptive alt text for accessibility. Add alt attributes to all images in the document.

Example for the first image:

-<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" />
+<image src="https://mdn.alipayobjects.com/huamei_w6ifet/afts/img/A*natiS7i3cvUAAAAAAAAAAAAADjCHAQ/fmt.webp" alt="WeChat Mini Game export configuration panel" />

Also applies to: 16-21, 29-29, 41-41, 49-49, 54-54, 61-61

Comment on lines +8 to +10
## 平台配置说明

在导出到微信小游戏平台的时候,有以下这些配置项:
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Content should be in English for consistency.

This section title and the following paragraph are in Chinese while the document is in the English documentation folder (docs/en). Please translate to English for consistency.

-## 平台配置说明
-
-在导出到微信小游戏平台的时候,有以下这些配置项:
+## Platform Configuration
+
+When exporting to the WeChat Mini Game platform, the following configuration options are available:
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 平台配置说明
在导出到微信小游戏平台的时候,有以下这些配置项:
## Platform Configuration
When exporting to the WeChat Mini Game platform, the following configuration options are available:

label: Platform
---

为了满足广大开发者对各个平台上线的诉求,真正做到一处开发,处处运行,Galacean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Content should be in English for consistency.

The entire content appears to be in Chinese while this is in the English documentation folder (docs/en). Please translate to English for consistency.

For the first paragraph:

-为了满足广大开发者对各个平台上线的诉求,真正做到一处开发,处处运行,Galacean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。
+To meet developers' needs for multi-platform deployment and achieve true "write once, run anywhere" functionality, Galacean 1.4 introduces multi-platform export capabilities. Projects created in the editor can be quickly exported to different platform-specific projects.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
为了满足广大开发者对各个平台上线的诉求,真正做到一处开发,处处运行,Galacean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。
To meet developers' needs for multi-platform deployment and achieve true "write once, run anywhere" functionality, Galacean 1.4 introduces multi-platform export capabilities. Projects created in the editor can be quickly exported to different platform-specific projects.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~8-~8: 动词的修饰一般为‘形容词(副词)+地+动词’。您的意思是否是:快速"地"导出
Context: ...acean 1.4 版本开始支持多平台导出。开发者通过编辑器制作的项目,可以快速的导出到不同的平台所需的工程。 ## 前置准备 项目在编辑器中开发完成后,就可以...

(wb4)

Comment on lines +49 to +51
[导出至 H5 平台](/en/docs/platform/h5/)

[导出至微信小游戏平台](/en/docs/platform/wechatMiniGame/)
Copy link

Choose a reason for hiding this comment

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

💡 Codebase verification

Links need to be updated to match the repository structure

The current links include an incorrect path segment. They should be:

  • /en/platform/h5/ (remove "docs")
  • /en/platform/wechatMiniGame/ (remove "docs")
🔗 Analysis chain

Verify documentation links.

The links to platform-specific documentation need verification to ensure they are correct and accessible.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if the linked documentation files exist
echo "Checking H5 documentation link..."
[ -f "docs/en/platform/h5.md" ] && echo "✓ H5 doc exists" || echo "✗ H5 doc missing"

echo "Checking WeChat Mini Game documentation link..."
[ -f "docs/en/platform/wechatMiniGame.md" ] && echo "✓ WeChat doc exists" || echo "✗ WeChat doc missing"

Length of output: 355


Script:

#!/bin/bash
# List all platform documentation files
echo "=== All platform documentation files ==="
fd . "docs/en/platform" -t f

echo -e "\n=== Content preview of h5.md ==="
head -n 5 docs/en/platform/h5.md

echo -e "\n=== Content preview of wechatMiniGame.md ==="
head -n 5 docs/en/platform/wechatMiniGame.md

# Check if there's a docs/en/docs directory (as used in links)
echo -e "\n=== Checking alternate docs path ==="
[ -d "docs/en/docs" ] && echo "docs/en/docs exists" || echo "docs/en/docs does not exist"

Length of output: 794

Comment on lines +8 to +11
## 平台配置说明

导出到 H5 平台,除了通用导出配置外,并没有额外的平台相关导出配置,故无需配置

Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Content should be in English for consistency.

This section and the following content are in Chinese while the document is in the English documentation folder (docs/en). Please translate to English for consistency.

-## 平台配置说明
-
-导出到 H5 平台,除了通用导出配置外,并没有额外的平台相关导出配置,故无需配置
+## Platform Configuration
+
+When exporting to the H5 platform, no additional platform-specific configurations are required beyond the general export settings.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
## 平台配置说明
导出到 H5 平台,除了通用导出配置外,并没有额外的平台相关导出配置,故无需配置
## Platform Configuration
When exporting to the H5 platform, no additional platform-specific configurations are required beyond the general export settings.

└── ... # 其他
```

**备注:** 因为 React/Vue/Vanilla JS 均属于 H5 平台,且大同小异,文档统一以 React 进行说明
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Translate note to English.

The note about React/Vue/Vanilla JS should be in English for consistency.

-**备注:** 因为 React/Vue/Vanilla JS 均属于 H5 平台,且大同小异,文档统一以 React 进行说明
+**Note:** Since React/Vue/Vanilla JS are all part of the H5 platform and share similar characteristics, this documentation uses React for illustration purposes.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
**备注:** 因为 React/Vue/Vanilla JS 均属于 H5 平台,且大同小异,文档统一以 React 进行说明
**Note:** Since React/Vue/Vanilla JS are all part of the H5 platform and share similar characteristics, this documentation uses React for illustration purposes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant