Improve introduction category (#74)

* Improve introduction category, remove several todos * Try to improve upper camel case explantion * Adress review: - Fix typos, - Better wording - Add explanation for genSources Co-authored-by: ix0rai <[email protected]> --------- Co-authored-by: ix0rai <[email protected]>
QuiltMC · Feb 6, 2024 · 6f19e88 · 6f19e88 · Cozy-GitHub · Feb 6, 2024
1 parent dc177a8
commit 6f19e88
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 9 deletions.
diff --git a/wiki/introduction/get-started/en.md b/wiki/introduction/get-started/en.md
@@ -8,19 +8,29 @@ In order to start modding Minecraft, you'll need to know a couple of things.
   programming, and some essential design patterns.
 - Basic [Git](https://git-scm.com/) knowledge. While technically not necessary, it'll
   make your life a lot easier. This includes understanding how to clone repositories
-  and make commits.
+  and make commits. Some great resources include the [Git docs](https://git-scm.com/doc) and the [GitHub docs](https://docs.github.com/en/get-started)
 
-TODO: Is there anything more to be described here?
+<!-- TODO: Is there anything more to be described here? -->
 
 ## How to Use this Wiki
 
-TODO: Create example code repository and put it here
+TODO: Create example code repository and put it here ([Issue #68](https://github.com/QuiltMC/developer-wiki/issues/68))
 
 This wiki contains pages that are best read in order. Many of the articles, especially at the beginning, suggest other articles sensible to continue with. Most pages will contain code snippets, with full examples planned to be provided in example mods. (This is not done yet)
 
 Additionally, you might account lines prefixed with `TODO: `. Those are notes for people working on the wiki what still needs to be done. For now, you can ignore them. Just know that there is more content to be inserted there.
 
-TODO: Give an outline of all of the wiki articles once they're ready
+In the next article, you will set up your first mod to get started with mod development.
+
+After that, it is recommended to look into [Creating your First Item](../items/first-item). Then, you are ready for [adding blocks](../blocks/first-block), or creating advanced items, like [food](../items/food), [tools](../items/tools) and [armor](../items/armor).
+
+For more general explanations, you can look into the Concepts category:
+
+- In [QSL and QFAPI Overview](../concepts/qsl-qfapi) you get an overview on Quilt Standard Libraries and Quilted Fabric API, Quilt's official APIs.
+
+Many more articles are planned, but not done yet ([Issue #69](https://github.com/QuiltMC/developer-wiki/issues/69)). This section will be updated later.
+
+<!-- TODO: Give an outline of all of the wiki articles once they're ready. -->
 
 ## How to Learn Modding, for Beginners
 
@@ -32,19 +42,24 @@ Asking questions properly, whether it is on our forum or on Discord, is an essen
 skill to have. Never be afraid to ask questions, we're always willing to help, and we
 don't judge.
 
-TODO: Methodology for asking questions here
+When asking questions, try to include the necessary context in your first message, and [do not ask to ask](https://dontasktoask.com/). State your problem, what you have already tried to solve it, and how those attempts failed. Make sure to avoid the [XY problem](https://xyproblem.info/) by not only asking for help for one specific part of a solution to your problem, but also stating the actual problem you are trying to solve. When debugging, include your `latest.log` and when your game crashes, a crash log. Additionally, full access to your source code can be really helpful, ideally uploaded to a website such as GitHub.
+
+You can ask development related questions in our [Forum](https://forum.quiltmc.org/), as well as in the [mod-dev-help](https://discord.com/channels/817576132726620200/1047429688521396325) forum channel in our [Discord](https://discord.quiltmc.org/)
 
 Many problems have been solved in modding before, and are publicly available for you
 to see and use as most mods for Quilt are open source. We recommend that you look at
 examples of how to do things in open source repositories and sometimes "steal" code.
 Open source repositories are there for you to learn from and use, don't be afraid of
 them!
 
-TODO: Levi write your thing about stealing code here
+There are many topics in modding where you quickly will find yourself at a point where there are no tutorials to help. In those cases you'll usually either have to understand the relevant Minecraft code, or look at other mods and see how they got similar things done.
+If you want to look into the Minecraft source code, run the `genSourcesWithVineflower` Gradle task in the `fabric` category or open any Minecraft source file and click the download sources button in IntelliJ IDEA.
+
+<!-- TODO: Is this todo fixed?: Levi write your thing about stealing code here -->
 
 ## Differences between Fabric and Quilt
 
-Quilt is a fork of the Fabric modloader. However, there are some key differences with
+Quilt is a fork of the Fabric mod loader. However, there are some key differences with
 Quilt when compared with Fabric.
 
 TODO: Levi write your thing here
diff --git a/wiki/introduction/setting-up/en.md b/wiki/introduction/setting-up/en.md
@@ -5,7 +5,7 @@ You'll need a couple of things before you can get started.
 - A Java Development Kit (JDK) for Java 17 (recommended) or newer.
   Temurin Adoptium JDKs are easily available and recommended.
   You can download them here: <https://adoptium.net/releases.html>
-- Any Java IDE, like [IntelliJ Idea](https://www.jetbrains.com/idea/) or [Eclipse](https://www.eclipse.org/ide/).
+- Any Java IDE, like [IntelliJ IDEA](https://www.jetbrains.com/idea/) or [Eclipse](https://www.eclipse.org/ide/).
   [Visual Studio Code](https://code.visualstudio.com/) can work, but it takes extra work to get set up.
   - We recommend using IntelliJ IDEA as it has the most integrations and is the easiest to use.
 
@@ -109,7 +109,7 @@ You'll need to update a few things under `"quilt_loader"`, see below for a final
       but typically people put a `"homepage"`, a `"sources"`, and a `"issues"` entry with a valid URL here.
    5. Replace `example_mod` with your mod's ID in `"icon"`.
 4. In `"entrypoints"`, replace `com.example.example_mod` with your Maven group and mod ID,
-   and the `ExampleMod` at the end should be the Java class name for your mod. The Java class name usually is your mod's name, written in `UpperCamelCase` (So new words simply start by using a uppercase letter and the initial latter is also upper case)
+   and the `ExampleMod` at the end should be the Java class name for your mod. The Java class name usually is your mod's name, written in `UpperCamelCase`. This means that instead of using spaces to separate words, each word starts with an uppercase letter. In contrast to `lowerCamelCase`, the first letter should be uppercase.
    For example, `io.github.bingus.bingus_mod.BingusMod`.
 5. In `"mixin"`, replace `example_mod` in the file name to your mod's ID.