Worlds Guide + Resolved some broken links #178
Conversation
✅ Deploy Preview for sklauncher-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughUpdated two internal shader documentation links to point under Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🧰 Additional context used🪛 LanguageTooldocs/modding/mods/worlds.mdx[uncategorized] ~10-~10: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) [style] ~11-~11: Consider using an extreme adjective for ‘old’. (EXTREME_ADJECTIVES) [uncategorized] ~15-~15: “and” (in addition to, following this) seems less likely than “an” (indefinite article before a vowel sound). (AI_HYDRA_LEO_CP_AND_AN) [style] ~15-~15: The word ‘anyways’ is informal American English. Did you mean “anyway”? (ANYWAYS) [uncategorized] ~22-~22: Possible missing comma found. (AI_HYDRA_LEO_MISSING_COMMA) 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 |
Summary of ChangesHello @AquaCobalt, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation by introducing a detailed guide for installing Minecraft worlds, which will assist users in correctly setting up new game environments. Concurrently, it addresses and resolves existing broken internal links within the OptiFine mod documentation, improving the overall navigability and accuracy of the modding guides. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request introduces a new guide for installing Minecraft worlds and fixes a couple of broken links in the OptiFine installation guide. The link fixes are correct. The new guide on installing worlds is a great addition, but I've found a few areas where the formatting and clarity could be improved to ensure the instructions are easy to follow. My comments focus on improving the markdown structure and wording for better readability.
| ::: | ||
| ## Downloading & Installing Worlds | ||
| 1. Verify that the file you downloaded/received is a `.zip` file. | ||
| - Safari on macOS might sometimes download `.zip` files as a folder, and in that case, you don't have to worry about this because you'll need it to be and extracted folder anyways. |
There was a problem hiding this comment.
This sentence is a bit unclear and contains a typo. It could be rephrased for better clarity. The word 'and' should be 'an'. A clearer way to phrase this might be to explain that Safari automatically unzips the file, which is the action required in the next step anyway.
- Safari on macOS might automatically unzip `.zip` files into a folder. This is fine, as you'll need an extracted folder for the next steps.
| 3. Verify that the folder structure is correct (Optional but recommended)\ | ||
| The unzipped folder must contain its own `data`, `poi`, and `region` folders.\ | ||
| These folders should be directly under the unzipped folder; for example it should be; | ||
| ``` | ||
| World(.zip) | ||
| ├── level.dat | ||
| ├── region/ | ||
| ├── data/ | ||
| ├── poi/ | ||
| └── (other files) | ||
| ``` | ||
| and **NOT;** | ||
| ``` | ||
| World(.zip) | ||
| └── World/ | ||
| ├── level.dat | ||
| ├── region/ | ||
| ├── data/ | ||
| └── poi/ | ||
| ``` | ||
|
|
||
| <small>\* - If you modified your [game directory](/faq/launcher-related#how-does-game-directory-work), then you should look for the `saves` folder in that location.</small> | ||
|
|
||
| 4. You can now launch the game and select the world through the main menu > Singleplayer. |
There was a problem hiding this comment.
The formatting of this numbered list has a few issues that will cause it to render incorrectly and might confuse users:
- The content under step 3 is not indented, which will break the list numbering.
- The footnote at line 41 is also not indented and is placed between steps, further breaking the list. It also refers to step 2 but is placed after step 3.
- The
World(.zip)placeholder in the examples is confusing.
I've provided a suggestion that fixes these formatting and clarity issues by properly indenting content, using a clearer placeholder, and moving the footnote to the end of the list.
3. Verify that the folder structure is correct (Optional but recommended)
The unzipped folder must contain its own `data`, `poi`, and `region` folders.
These folders should be directly under the unzipped folder; for example it should be;
World/
├── level.dat
├── region/
├── data/
├── poi/
└── (other files)
and **NOT;**
World/
└── World/
├── level.dat
├── region/
├── data/
└── poi/
4. You can now launch the game and select the world through the main menu > Singleplayer.
<small>* - If you modified your [game directory](/faq/launcher-related#how-does-game-directory-work), then you should look for the `saves` folder in that location.</small>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
docs/modding/mods/optifine.mdx(1 hunks)docs/modding/mods/worlds.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/modding/mods/worlds.mdx
[typographical] ~6-~6: The word “otherwise” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...ger Always download worlds from trusted sources, otherwise they may cause harm to your operating s...
(THUS_SENTENCE)
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...rlds are usually downloaded as a .zip file while Minecraft: Bedrock Edition world ...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...ually downloaded as a .mcworld file.\ Also verify that the world you downloaded is...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...r versions won't work on older clients (ie. 1.21 worlds won't work on 1.14). For ol...
(I_E)
[style] ~11-~11: Consider using an extreme adjective for ‘old’.
Context: ...nts, it should generally work fine, but extremely old worlds won't work. ::: ## Downloading &...
(EXTREME_ADJECTIVES)
[uncategorized] ~15-~15: “and” (in addition to, following this) seems less likely than “an” (indefinite article before a vowel sound).
Context: ...about this because you'll need it to be and extracted folder anyways. 2. Unzip ...
(AI_HYDRA_LEO_CP_AND_AN)
[style] ~15-~15: The word ‘anyways’ is informal American English. Did you mean “anyway”?
Context: ...u'll need it to be and extracted folder anyways. 2. Unzip it to the saves directory...
(ANYWAYS)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...directly under the unzipped folder; for example it should be; ``` World(.zip) ├── level...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
docs/modding/mods/optifine.mdx (1)
41-41: ✓ Link path corrections are consistent and aligned with documentation reorganization.Both shader guide links have been correctly updated to the new
/modding/mods/shaderspath, resolving the broken link references as intended.Also applies to: 44-44
docs/modding/mods/worlds.mdx (1)
13-43: ✓ Technical content, structure, and examples are well-presented.The step-by-step instructions are clear and comprehensive:
- OS-specific directory paths are correctly formatted (Windows %AppData%, macOS Library path, Linux home directory).
- The folder structure comparison effectively demonstrates correct vs. incorrect nesting patterns.
- Marking step 3 as optional but recommended is appropriate, respecting user autonomy while encouraging best practice.
- The footnote about modified game directories appropriately handles edge cases.
There was a problem hiding this comment.
Actionable comments posted: 0
♻️ Duplicate comments (4)
docs/modding/mods/worlds.mdx (4)
11-11: Fix abbreviation format: "ie." → "i.e."The abbreviation "i.e." (id est, meaning "that is") requires two periods, not one.
-Worlds on newer versions won't work on older clients (ie. 1.21 worlds won't work on 1.14). +Worlds on newer versions won't work on older clients (i.e. 1.21 worlds won't work on 1.14).
15-15: Fix article and word choice: "and extracted" → "an extracted", "anyways" → "anyway"Two issues here: the indefinite article before a vowel sound should be "an" not "and", and "anyways" is informal; use "anyway" instead.
- - Safari on macOS might sometimes download `.zip` files as a folder, and in that case, you don't have to worry about this because you'll need it to be and extracted folder anyways. + - Safari on macOS might sometimes download `.zip` files as a folder, and in that case, you don't have to worry about this because you'll need it to be an extracted folder anyway.
20-22: Fix list indentation and add missing comma in step 3.Lines 21–22 should be indented as part of step 3 to preserve list structure. Additionally, add a comma after "for example" on line 22.
3. Verify that the folder structure is correct (Optional but recommended)\ -The unzipped folder must contain its own `data`, `poi`, and `region` folders.\ -These folders should be directly under the unzipped folder; for example it should be; + The unzipped folder must contain its own `data`, `poi`, and `region` folders.\ + These folders should be directly under the unzipped folder; for example, it should be;
41-41: Reposition footnote after step 4.The footnote at line 41 is currently placed between step 3 and step 4, which disrupts the list flow. Move it after step 4 to maintain proper list structure.
4. You can now launch the game and select the world through the main menu > Singleplayer. + +<small>\* - If you modified your [game directory](/faq/launcher-related#how-does-game-directory-work), then you should look for the `saves` folder in that location.</small>Then remove it from its current position (line 41).
🧹 Nitpick comments (1)
docs/modding/mods/worlds.mdx (1)
24-24: Clarify the folder placeholder naming.The placeholder
World(.zip)is ambiguous—it's unclear whether the(.zip)part refers to the folder name or just the archive format. Consider using a clearer name likeWorldormy-worldto avoid confusion since the folder is already unzipped at this point.-World(.zip)
+World
├── level.dat
├── region/
├── data/
├── poi/
└── (other files)and **NOT;**-World(.zip)
+World
└── World/
├── level.dat
├── region/
├── data/
└── poi/Also applies to: 33-33
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/modding/mods/worlds.mdx(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/modding/mods/worlds.mdx
[uncategorized] ~10-~10: Possible missing comma found.
Context: ...ually downloaded as a .mcworld file.\ Also verify that the world you downloaded is...
(AI_HYDRA_LEO_MISSING_COMMA)
[uncategorized] ~11-~11: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...r versions won't work on older clients (ie. 1.21 worlds won't work on 1.14). For ol...
(I_E)
[style] ~11-~11: Consider using an extreme adjective for ‘old’.
Context: ...nts, it should generally work fine, but extremely old worlds won't work. ::: ## Downloading &...
(EXTREME_ADJECTIVES)
[uncategorized] ~15-~15: “and” (in addition to, following this) seems less likely than “an” (indefinite article before a vowel sound).
Context: ...about this because you'll need it to be and extracted folder anyways. 2. Unzip ...
(AI_HYDRA_LEO_CP_AND_AN)
[style] ~15-~15: The word ‘anyways’ is informal American English. Did you mean “anyway”?
Context: ...u'll need it to be and extracted folder anyways. 2. Unzip it to the saves directory...
(ANYWAYS)
[uncategorized] ~22-~22: Possible missing comma found.
Context: ...directly under the unzipped folder; for example it should be; ``` World(.zip) ├── level...
(AI_HYDRA_LEO_MISSING_COMMA)
1 participant
Summary by CodeRabbit