-
Notifications
You must be signed in to change notification settings - Fork 92
Added description of USM files in KH3 #1244
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
base: master
Are you sure you want to change the base?
Conversation
📝 WalkthroughWalkthroughAdds a new documentation page describing USM (CriMovie) usage and file layout for Kingdom Hearts III and updates the KH3 docs index to link to it. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
📜 Recent review detailsConfiguration used: defaults Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageTooldocs/kh3/crimovie.md[grammar] ~24-~24: Ensure spelling is correct (QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1) ⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
🔇 Additional comments (1)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 3
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/kh3/crimovie.mddocs/kh3/index.md
🧰 Additional context used
🪛 LanguageTool
docs/kh3/crimovie.md
[grammar] ~23-~23: Ensure spelling is correct
Context: ...x | Japanese (for Asian Market) | ### day1 To prevent pre-release leaks of the epil...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~25-~25: Ensure spelling is correct
Context: ... of the epilogue and secret ending, the day1 files were originally shipped in a sepa...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🪛 markdownlint-cli2 (0.18.1)
docs/kh3/crimovie.md
6-6: Link text should be descriptive
(MD059, descriptive-link-text)
48-48: No empty links
(MD042, no-empty-links)
docs/kh3/index.md
11-11: Unordered list indentation
Expected: 2; Actual: 4
(MD007, ul-indent)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: build
- GitHub Check: Analyze (csharp)
🔇 Additional comments (1)
docs/kh3/crimovie.md (1)
1-159: LGTM on documentation structure and comprehensiveness.The new USM documentation is well-organized with clear sections for format overview, language variants, and comprehensive file listings with cross-references to video content. The tables are properly structured, and file-to-world mappings provide valuable context. Once the minor linting issues (link descriptiveness and empty link) are resolved, this documentation will be a valuable addition to the KH3 reference material.
- Adjusted link text to comply with MD059 - Removed empty link
|
Took care of CodeRabbit's suggestions. That was actually quite helpful. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
📜 Review details
Configuration used: defaults
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/kh3/crimovie.mddocs/kh3/index.md
🚧 Files skipped from review as they are similar to previous changes (1)
- docs/kh3/index.md
🧰 Additional context used
🪛 LanguageTool
docs/kh3/crimovie.md
[grammar] ~24-~24: Ensure spelling is correct
Context: ...x | Japanese (for Asian Market) | ### day1 To prevent pre-release leaks of the epil...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)
- GitHub Check: Analyze (csharp)
- GitHub Check: build
🔇 Additional comments (2)
docs/kh3/crimovie.md (2)
12-12: ✓ Descriptive link text is now in place.The previous review flagged the use of "here" as non-descriptive link text. The current version now uses "[Criware's USM format Part 1]" which clearly indicates what the resource is about. Good fix!
49-49: ✓ Empty link issue resolved.The previous review flagged an empty link on this line. It's now been converted to plain text "Timelapse of Clouds in Tutorial Section" with no broken link syntax. Good!
Since we can now control the game's USM files and update them with custom ones, I added a new page to the docs with an overview of all USMs in the game.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.