Add two new docs pages

Developing a Modpack and Exporting a Modpack
juraj-hrivnak · Mar 20, 2024 · 887df06 · 887df06
1 parent d546aff
commit 887df06
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 6 deletions.
diff --git a/docs/p.tree b/docs/p.tree
@@ -16,6 +16,8 @@
         <toc-element topic="Setting-Up-a-Modpack.md"/>
         <toc-element topic="Managing-Projects.md"/>
         <toc-element topic="Getting-Info-About-Your-Modpack.md"/>
+        <toc-element topic="Developing-a-Modpack.md"/>
+        <toc-element topic="Exporting-a-Modpack.md"/>
     </toc-element>
     <toc-element toc-title="CLI Commands">
         <toc-element topic="pakku.md"/>

diff --git a/docs/topics/Developing-a-Modpack.md b/docs/topics/Developing-a-Modpack.md
@@ -0,0 +1,13 @@
+# Developing a Modpack
+
+To be able to properly run and start working on your modpack, you need to have
+[project files](Pakku-Terminology.md#project-file) fetched to your modpack folder.
+
+To do that, run the [`pakku fetch`](pakku-fetch.md) command:
+
+<include from="pakku-fetch.md" element-id="snippet-cmd"></include>
+
+This will: download [project files](Pakku-Terminology.md#project-file),
+remove old [project files](Pakku-Terminology.md#project-file) and
+copy [project overrides](Pakku-Terminology.md#project-override)
+from the [Pakku directory](Pakku-Directory.md) to your modpack folder.
diff --git a/docs/topics/Exporting-a-Modpack.md b/docs/topics/Exporting-a-Modpack.md
@@ -0,0 +1,2 @@
+# Exporting a Modpack
+
diff --git a/docs/topics/Installing-Pakku.md b/docs/topics/Installing-Pakku.md
@@ -2,16 +2,14 @@
 
 [//]: # (To run Pakku, you have two options:)
 
-Currently, the only option to run Pakku is:
-
-- [Run Pakku using Java](#running_pakku_using_java).
-    - This requires Java to be installed on your computer.
+Currently, the only option is to [install and run Pakku using Java](#install-java).
+This requires Java to be installed on your computer.
 
 [//]: # (2. [Run Pakku as native executable]&#40;#running_pakku_as_native_executable&#41;.)
 
 [//]: # (    - Depending on your operating system, you will need to use a different version of native Pakku.)
 
-<procedure title="Running Pakku using Java" id="running_pakku_using_java">
+<procedure title="Install and run Pakku using Java" id="install-java">
 
 1. Check whether you have Java installed on your computer.
    If not, install it from [here](https://www.java.com/en/download/).
@@ -25,7 +23,7 @@ Currently, the only option to run Pakku is:
    ```
    {prompt="$"}
 
-   > To get to your modpack folder, use the `cd` command.
+   > To get to your modpack folder, use the [`cd` command](https://en.wikipedia.org/wiki/Cd_(command)).
    {style="note"}
 
 </procedure>

diff --git a/docs/topics/pakku-rm.md b/docs/topics/pakku-rm.md
@@ -22,5 +22,6 @@ Remove projects.
 
 `-h`, `--help`
 : Show help message and exit
+{id="option-help"}
 
 </snippet>