Add spine en doc for using in code. #2496
Conversation
WalkthroughThis pull request introduces a comprehensive documentation chapter for the Galacean Spine runtime in the English documentation. The new section, titled "Using in Code", provides detailed guidance on installing the Spine runtime package, importing the Changes
Suggested labels
Suggested reviewers
Possibly related PRs
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 (
|
github-actions
bot
added
the
documentation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2496 +/- ##
==========================================
+ Coverage 70.56% 70.57% +0.01%
==========================================
Files 526 526
Lines 27627 27627
Branches 4161 4161
==========================================
+ Hits 19495 19498 +3
+ Misses 6573 6570 -3
Partials 1559 1559
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
![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 (4)
docs/en/graphics/2D/spine/runtime.md (4)
83-87: Consider using code blocks for URL examples.For better readability and consistency, consider wrapping the example URLs in a code block:
-<br>https://your.spineboy.json<br>https://your.spineboy.atlas<br>https://your.spineboy.png<br> +``` +https://your.spineboy.json +https://your.spineboy.atlas +https://your.spineboy.png +```🧰 Tools
🪛 Markdownlint (0.37.0)
85-85: null
Bare URL used(MD034, no-bare-urls)
85-85: null
Bare URL used(MD034, no-bare-urls)
85-85: null
Bare URL used(MD034, no-bare-urls)
102-103: Consider using code blocks for URL examples with query parameters.For better readability and consistency, consider wrapping the example URLs in a code block:
-<br>https://your.spineboyjson?ext=.json<br>https://your.spineboyatlas?ext=.atlas<br> +``` +https://your.spineboyjson?ext=.json +https://your.spineboyatlas?ext=.atlas +```🧰 Tools
🪛 Markdownlint (0.37.0)
102-102: null
Bare URL used(MD034, no-bare-urls)
102-102: null
Bare URL used(MD034, no-bare-urls)
231-234: Improve bullet points formatting.For better readability and consistency with markdown standards, consider reformatting the parameters list:
- - `TrackIndex`: The track index of the animation. - - `animationName`: The name of the animation. - - `loop`: Whether to loop the animation. +* `TrackIndex`: The track index of the animation +* `animationName`: The name of the animation +* `loop`: Whether to loop the animation🧰 Tools
🪛 LanguageTool
[uncategorized] ~231-~231: Loose punctuation mark.
Context: ...ccepts three parameters: -TrackIndex: The track index of the animation. - `an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...ndex of the animation. -animationName: The name of the animation. -loop: Wh...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...me: The name of the animation. -loop`: Whether to loop the animation. The las...(UNLIKELY_OPENING_PUNCTUATION)
403-404: Use proper markdown headers instead of bold text.For better document structure and consistency, replace bold text with proper markdown headers:
-**Skin Switching** +### Skin Switching -**Skin Mixing** +### Skin MixingAlso applies to: 421-422
🧰 Tools
🪛 Markdownlint (0.37.0)
403-403: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/en/graphics/2D/spine/runtime.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/en/graphics/2D/spine/runtime.md
[style] ~101-~101: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lative to the atlas file's path.
- If the custom uploaded asset has no file e...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~231-~231: Loose punctuation mark.
Context: ...ccepts three parameters: - TrackIndex: The track index of the animation. - `an...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...ndex of the animation. - animationName: The name of the animation. - loop: Wh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...me: The name of the animation. - loop`: Whether to loop the animation. The las...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...accepts four parameters: - TrackIndex: The animation track. - animationName:...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~269-~269: Loose punctuation mark.
Context: ...: The animation track. - animationName: The name of the animation. - loop: Wh...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~270-~270: Loose punctuation mark.
Context: ...me: The name of the animation. - loop: Whether to loop the animation. - delay...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...Whether to loop the animation. - delay: The delay time. The first three parame...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~302-~302: Loose punctuation mark.
Context: ...imation control, such as: - timeScale: Controls the playback speed of the anim...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~303-~303: Loose punctuation mark.
Context: ...eed of the animation. - animationStart: Controls the start time of the animatio...
(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...e start time of the animation. - alpha: The blending coefficient for applying t...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
docs/en/graphics/2D/spine/runtime.md
85-85: null
Bare URL used
(MD034, no-bare-urls)
85-85: null
Bare URL used
(MD034, no-bare-urls)
85-85: null
Bare URL used
(MD034, no-bare-urls)
102-102: null
Bare URL used
(MD034, no-bare-urls)
102-102: null
Bare URL used
(MD034, no-bare-urls)
403-403: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
421-421: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
⏰ Context from checks skipped due to timeout of 90000ms (5)
- GitHub Check: build (22.x, windows-latest)
- GitHub Check: build (22.x, macos-latest)
- GitHub Check: e2e (22.x)
- GitHub Check: build (22.x, ubuntu-latest)
- GitHub Check: codecov
🔇 Additional comments (1)
docs/en/graphics/2D/spine/runtime.md (1)
1-448: Well-structured and comprehensive documentation!The documentation provides a thorough guide to using the Galacean Spine runtime, with clear examples and explanations. The content progression from basic setup to advanced features is logical and easy to follow.
🧰 Tools
🪛 LanguageTool
[style] ~101-~101: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...lative to the atlas file's path.
- If the custom uploaded asset has no file e...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~231-~231: Loose punctuation mark.
Context: ...ccepts three parameters: -TrackIndex: The track index of the animation. - `an...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~232-~232: Loose punctuation mark.
Context: ...ndex of the animation. -animationName: The name of the animation. -loop: Wh...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~233-~233: Loose punctuation mark.
Context: ...me: The name of the animation. -loop`: Whether to loop the animation. The las...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~268-~268: Loose punctuation mark.
Context: ...accepts four parameters: -TrackIndex: The animation track. -animationName:...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~269-~269: Loose punctuation mark.
Context: ...: The animation track. -animationName: The name of the animation. -loop: Wh...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~270-~270: Loose punctuation mark.
Context: ...me: The name of the animation. -loop: Whether to loop the animation. -delay...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~271-~271: Loose punctuation mark.
Context: ...Whether to loop the animation. -delay: The delay time. The first three parame...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~302-~302: Loose punctuation mark.
Context: ...imation control, such as: -timeScale: Controls the playback speed of the anim...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~303-~303: Loose punctuation mark.
Context: ...eed of the animation. -animationStart: Controls the start time of the animatio...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~304-~304: Loose punctuation mark.
Context: ...e start time of the animation. -alpha: The blending coefficient for applying t...(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
85-85: null
Bare URL used(MD034, no-bare-urls)
85-85: null
Bare URL used(MD034, no-bare-urls)
85-85: null
Bare URL used(MD034, no-bare-urls)
102-102: null
Bare URL used(MD034, no-bare-urls)
102-102: null
Bare URL used(MD034, no-bare-urls)
403-403: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
421-421: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
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
SpineAnimationRenderercomponent