docs: add advanced shader docs #2295
Conversation
|
Caution Review failedThe pull request is closed. WalkthroughThe recent documentation updates introduce comprehensive guides for various shaders, including eye, hair, skin, and thin film interference shaders. Each guide details shader functionalities, parameters, and practical usage within the Galacean editor, enhanced with visual aids. This structured documentation aims to empower users in developing realistic graphical representations in their projects. Changes
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 as PR comments)
Additionally, you can add 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: 2
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (4)
- docs/zh/graphics/shader/builtins/eye.mdx (1 hunks)
- docs/zh/graphics/shader/builtins/hair.mdx (1 hunks)
- docs/zh/graphics/shader/builtins/skin.mdx (1 hunks)
- docs/zh/graphics/shader/builtins/thin.mdx (1 hunks)
Additional context used
LanguageTool
docs/zh/graphics/shader/builtins/eye.mdx
[uncategorized] ~5-~5: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：真实"地"渲染
Context: --- title: 眼睛着色器 --- 眼睛着色器为眼球模型提供真实的渲染，使你的创作呈现逼真的艺术效果。 <img src="https://md...(wb4)
[uncategorized] ~22-~22: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：好"地"使用
Context: ...ject**。 ## 眼球剖析 在开始渲染眼睛前，熟悉眼球的生物结构以便更好的使用着色器。 | 参数 | ...(wb4)
Additional comments not posted (16)
docs/zh/graphics/shader/builtins/skin.mdx (4)
16-23: LGTM!The material properties section is clear and well-structured.
1-7: Verify the image link.Ensure that the image link is accessible and displays correctly.
Verification successful
The image link is accessible and returns an HTTP status 200.
- The image link in the markdown file is valid and should display correctly.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image link. # Test: Fetch the image URL. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*ynWiSp_2n90AAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 771
9-14: Verify the project link.Ensure that the project link is accessible and leads to the correct page.
Verification successful
The project link is valid and accessible.
The URL
https://galacean.antgroup.com/editor/projectsreturned an HTTP status 200, confirming that the link is accessible and leads to the correct page.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the project link. # Test: Fetch the project URL. Expect: HTTP status 200. curl -I "https://galacean.antgroup.com/editor/projects" | grep "HTTP/2 200"Length of output: 720
24-31: Verify the image links.Ensure that the image links are accessible and display correctly.
Verification successful
The image links are accessible and display correctly.
- Both image URLs returned HTTP status 200, confirming their accessibility.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image links. # Test: Fetch the image URLs. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*NLyOR71_nj4AAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200" curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*xfl_Ra0oj0AAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 1307
docs/zh/graphics/shader/builtins/hair.mdx (4)
19-31: LGTM!The material properties section is clear and well-structured.
16-17: Verify the image link.Ensure that the image link is accessible and displays correctly.
Verification successful
Image link is accessible.
The image link in the documentation is accessible and returns the expected HTTP status 200.
- docs/zh/graphics/shader/builtins/hair.mdx, lines 16-17
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image link. # Test: Fetch the image URL. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*IZrjTY7JbfkAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 455
1-7: Verify the image link.Ensure that the image link is accessible and displays correctly.
Verification successful
The image link is accessible.
The image URL provided in the documentation returns an HTTP status 200, indicating that the image is accessible and displays correctly.
- File:
docs/zh/graphics/shader/builtins/hair.mdx- Lines: 1-7
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image link. # Test: Fetch the image URL. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*k7t9RbgNMOIAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 455
9-14: Verify the project link.Ensure that the project link is accessible and leads to the correct page.
Verification successful
The project link is accessible and functional.
The link provided in the documentation correctly leads to the intended page.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the project link. # Test: Fetch the project URL. Expect: HTTP status 200. curl -I "https://galacean.antgroup.com/editor/projects" | grep "HTTP/2 200"Length of output: 483
docs/zh/graphics/shader/builtins/thin.mdx (4)
21-27: LGTM!The material properties section is clear and well-structured.
1-7: Verify the image link.Ensure that the image link is accessible and displays correctly.
Verification successful
Image link verified.
The image link is accessible and returns an HTTP/2 200 status.
- docs/zh/graphics/shader/builtins/thin.mdx, lines 1-7
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image link. # Test: Fetch the image URL. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*taABSY4nUcEAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 929
29-35: Verify the image links.Ensure that the image links are accessible and display correctly.
Verification successful
Image links are accessible and display correctly.
The image links in the code snippet return HTTP status 200, confirming their accessibility.
https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*opDFQY6Cu1EAAAAAAAAAAAAADgDwAQ/originalhttps://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*bfIhRIAinRIAAAAAAAAAAAAADgDwAQ/originalScripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the image links. # Test: Fetch the image URLs. Expect: HTTP status 200. curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*opDFQY6Cu1EAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200" curl -I "https://mdn.alipayobjects.com/huamei_9ahbho/afts/img/A*bfIhRIAinRIAAAAAAAAAAAAADgDwAQ/original" | grep "HTTP/2 200"Length of output: 1228
14-19: Verify the project link.Ensure that the project link is accessible and leads to the correct page.
Verification successful
The project link is accessible and leads to the correct page.
- The link provided in the documentation returns an HTTP status 200, indicating that it is accessible.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the project link. # Test: Fetch the project URL. Expect: HTTP status 200. curl -I "https://galacean.antgroup.com/editor/projects" | grep "HTTP/2 200"Length of output: 799
docs/zh/graphics/shader/builtins/eye.mdx (4)
9-11: Informative callout.The callout provides useful information about the shader's dependency on the model's UV and links to additional resources.
13-18: Clear instructions for importing the eye example.The section provides clear and concise steps to import an eye example in the Galacean editor.
32-41: Detailed descriptions of eye textures.The section provides clear and detailed descriptions of various textures used in the eye shader.
42-54: Detailed descriptions of material properties.The section provides clear and detailed descriptions of various material properties of the eye shader.
| title: 眼睛着色器 | ||
| --- | ||
|
|
||
| 眼睛着色器为眼球模型提供真实的渲染，使你的创作呈现逼真的艺术效果。 |
There was a problem hiding this comment.
Fix grammatical issue.
The sentence should use "地" to modify the verb.
- 眼睛着色器为眼球模型提供真实的渲染，使你的创作呈现逼真的艺术效果。
+ 眼睛着色器为眼球模型提供真实地渲染，使你的创作呈现逼真的艺术效果。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.
| 眼睛着色器为眼球模型提供真实的渲染，使你的创作呈现逼真的艺术效果。 | |
| 眼睛着色器为眼球模型提供真实地渲染，使你的创作呈现逼真的艺术效果。 |
Tools
LanguageTool
[uncategorized] ~5-~5: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：真实"地"渲染
Context: --- title: 眼睛着色器 --- 眼睛着色器为眼球模型提供真实的渲染，使你的创作呈现逼真的艺术效果。 <img src="https://md...(wb4)
|
|
||
| ## 眼球剖析 | ||
|
|
||
| 在开始渲染眼睛前，熟悉眼球的生物结构以便更好的使用着色器。 |
There was a problem hiding this comment.
Fix grammatical issue.
The sentence should use "地" to modify the verb.
- 在开始渲染眼睛前，熟悉眼球的生物结构以便更好的使用着色器。
+ 在开始渲染眼睛前，熟悉眼球的生物结构以便更好地使用着色器。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.
| 在开始渲染眼睛前，熟悉眼球的生物结构以便更好的使用着色器。 | |
| 在开始渲染眼睛前，熟悉眼球的生物结构以便更好地使用着色器。 |
Tools
LanguageTool
[uncategorized] ~22-~22: 动词的修饰一般为‘形容词（副词）+地+动词’。您的意思是否是：好"地"使用
Context: ...ject**。 ## 眼球剖析 在开始渲染眼睛前，熟悉眼球的生物结构以便更好的使用着色器。 | 参数 | ...(wb4)
* feat: update doc
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