Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@raoulvdberge
raoulvdberge committed Dec 22, 2023
1 parent b489a3d commit c9e337c
Show file tree
Hide file tree
Showing 9 changed files with 292 additions and 46 deletions.
9 changes: 0 additions & 9 deletions docs/component.json
View file

This file was deleted.

5 changes: 5 additions & 0 deletions docs/nav.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,11 @@
"ref": "faq.adoc",
"icon": "bi-question-circle-fill"
},
{
"title": "Need help?",
"ref": "need-help.adoc",
"icon": "bi-person-raised-hand"
},
{
"title": "Networking",
"ref": "networking/index.adoc",
Expand Down
4 changes: 0 additions & 4 deletions docs/pages/faq.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,6 @@ No, there isn't.

No, I won't.

== What versions of Minecraft are supported?

See xref:whats-new.adoc#_version_support[version support].

== Is there a way to have infinite Wireless Transmitter range?

It's not possible if you're using the base Refined Storage mod, or Refined Storage Addons.
Expand Down
7 changes: 0 additions & 7 deletions docs/pages/index.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1 @@
= Refined Storage

[.p-5.mb-4.bg-body-tertiary.rounded-3]
== Refined Storage is a mass storage mod for Minecraft that offers the player a network-based storage system, allowing them to store items and fluids on a massively expandable device network.
'''
Items and fluids can be stored in one of the many storage capabilities that the mod offers. Any storage devices connected to the same network are accessible to the player through one simple Grid interface, allowing the player to access the inventories of many devices through a single unified GUI.

This mod not only adds storage solutions, but also devices that can be used to manipulate items and blocks in the world and from within the system, such as importers, exporters, constructors, destructors, and more! There are also devices in this mod that allow the player to setup auto-crafting, allowing the crafting of complex recipes in a few simple clicks.
83 changes: 83 additions & 0 deletions docs/pages/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
<!DOCTYPE html>
<html layout:decorate="~{layout.html}">
<head>
<title th:utext="${title}"></title>
</head>
<body>
<div layout:fragment="content">
<main>
<div class="bg-body-tertiary mb-4 p-5 rounded-3 sect1">
<h2>Refined Storage is a mass storage mod for Minecraft that offers the player a network-based storage
system, allowing them to store items and fluids on a massively expandable device network.</h2>
<hr>
<p>Items and fluids can be stored in one of the many storage capabilities that
the mod offers. Any storage devices connected to the same network are accessible to the player
through one simple Grid interface, allowing the player to access the inventories of many devices
through a single unified GUI.</p>
<p>This mod not only adds storage solutions, but also devices that can be used to
manipulate items and blocks in the world and from within the system, such as importers, exporters,
constructors, destructors, and more! There are also devices in this mod that allow the player to
setup auto-crafting, allowing the crafting of complex recipes in a few simple clicks.</p>
<a class="btn btn-primary btn-lg"
th:href="@{'./' + ${currentComponent.slug} + '/' + ${currentComponent.latest ? '' : currentComponent.version.friendlyName() + '/'} + 'getting-started.html'}"
role="button">Get started</a>
</div>
</main>

<div class="btn-group btn-group-lg w-100" role="group" aria-label="Download">
<a href="https://www.curseforge.com/minecraft/mc-mods/refined-storage" class="btn btn-outline-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg" viewBox="-2017 853 43 23">
<path d="M-2005.7,853l0.7,3c-3.5,0-12,0-12,0s0.2,0.9,0.3,1c0.3,0.5,0.6,1.1,1,1.5c1.9,2.2,5.2,3.1,7.9,3.6 c1.9,0.4,3.8,0.5,5.7,0.6l2.2,5.9h1.2l0.7,1.9h-1l-1.7,5.5h16.7l-1.7-5.5h-1l0.7-1.9h1.2c0,0,1-6.1,4.1-8.9c3-2.8,6.7-3.2,6.7-3.2 V853H-2005.7z M-1988.9,868.1c-0.8,0.5-1.7,0.5-2.3,0.9c-0.4,0.2-0.6,0.8-0.6,0.8c-0.4-0.9-0.9-1.2-1.5-1.4 c-0.6-0.2-1.7-0.1-3.2-1.4c-1-0.9-1.1-2.1-1-2.7v-0.1c0-0.1,0-0.1,0-0.2s0-0.2,0.1-0.3l0,0l0,0c0.2-0.6,0.7-1.2,1.7-1.6 c0,0-0.7,1,0,2c0.4,0.6,1.2,0.9,1.9,0.5c0.3-0.2,0.5-0.6,0.6-0.9c0.2-0.7,0.2-1.4-0.4-1.9c-0.9-0.8-1.1-1.9-0.5-2.6 c0,0,0.2,0.9,1.1,0.8c0.6,0,0.6-0.2,0.4-0.4c-0.1-0.3-1.4-2.2,0.5-3.6c0,0,1.2-0.8,2.6-0.7c-0.8,0.1-1.7,0.6-2,1.4c0,0,0,0,0,0.1 c-0.3,0.8-0.1,1.7,0.5,2.5c0.4,0.6,0.9,1.1,1.1,1.9c-0.3-0.1-0.5,0-0.7,0.2c-0.2,0.2-0.3,0.6-0.2,0.9c0.1,0.2,0.3,0.4,0.5,0.4 c0.1,0,0.1,0,0.2,0h0.1c0.3-0.1,0.5-0.5,0.4-0.8c0.2,0.2,0.3,0.7,0.2,1c0,0.3-0.2,0.6-0.3,0.8c-0.1,0.2-0.3,0.4-0.4,0.6 s-0.2,0.4-0.2,0.6c0,0.2,0,0.5,0.1,0.7c0.4,0.6,1.2,0,1.4-0.5c0.3-0.6,0.2-1.3-0.2-1.9c0,0,0.7,0.4,1.2,1.8 C-1987.4,866.2-1988.1,867.6-1988.9,868.1z"></path>
</svg>
Download on CurseForge
</a>
<a href="https://modrinth.com/mod/refined-storage" class="btn btn-outline-primary">
<svg class="distribution-platform-logo" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 514">
<path fill-rule="evenodd" clip-rule="evenodd"
d="M503.16 323.56C514.55 281.47 515.32 235.91 503.2 190.76C466.57 54.2299 326.04 -26.8001 189.33 9.77991C83.8101 38.0199 11.3899 128.07 0.689941 230.47H43.99C54.29 147.33 113.74 74.7298 199.75 51.7098C306.05 23.2598 415.13 80.6699 453.17 181.38L411.03 192.65C391.64 145.8 352.57 111.45 306.3 96.8198L298.56 140.66C335.09 154.13 364.72 184.5 375.56 224.91C391.36 283.8 361.94 344.14 308.56 369.17L320.09 412.16C390.25 383.21 432.4 310.3 422.43 235.14L464.41 223.91C468.91 252.62 467.35 281.16 460.55 308.07L503.16 323.56Z"/>
<path d="M321.99 504.22C185.27 540.8 44.7501 459.77 8.11011 323.24C3.84011 307.31 1.17 291.33 0 275.46H43.27C44.36 287.37 46.4699 299.35 49.6799 311.29C53.0399 323.8 57.45 335.75 62.79 347.07L101.38 323.92C98.1299 316.42 95.39 308.6 93.21 300.47C69.17 210.87 122.41 118.77 212.13 94.7601C229.13 90.2101 246.23 88.4401 262.93 89.1501L255.19 133C244.73 133.05 234.11 134.42 223.53 137.25C157.31 154.98 118.01 222.95 135.75 289.09C136.85 293.16 138.13 297.13 139.59 300.99L188.94 271.38L174.07 231.95L220.67 184.08L279.57 171.39L296.62 192.38L269.47 219.88L245.79 227.33L228.87 244.72L237.16 267.79C237.16 267.79 253.95 285.63 253.98 285.64L277.7 279.33L294.58 260.79L331.44 249.12L342.42 273.82L304.39 320.45L240.66 340.63L212.08 308.81L162.26 338.7C187.8 367.78 226.2 383.93 266.01 380.56L277.54 423.55C218.13 431.41 160.1 406.82 124.05 361.64L85.6399 384.68C136.25 451.17 223.84 484.11 309.61 461.16C371.35 444.64 419.4 402.56 445.42 349.38L488.06 364.88C457.17 431.16 398.22 483.82 321.99 504.22Z"/>
</svg>
Download on Modrinth
</a>
<a href="https://github.com/refinedmods/refinedstorage/releases" class="btn btn-outline-primary">
<i class="bi bi-github"></i>
Download on GitHub
</a>
</div>

<div class="container bg-body-tertiary rounded-3 my-5 mt-4 pt-4">
<div class="row g-4 p-5 row-cols-1 row-cols-lg-3">
<div class="col">
<h2 class="h4"><i class="bi bi-discord"></i> Need help?</h2>
<p>Join our Discord server for community support.</p>
<a href="https://discordapp.com/invite/VYzsydb" class="icon-link d-inline-flex align-items-center">
Join our Discord server
<i class="bi bi-chevron-right"></i>
</a>
</div>
<div class="col">
<h2 class="h4"><i class="bi bi-bug-fill"></i> Found a problem?</h2>
<p>Issues can be reported on our issue tracker.</p>
<a href="https://github.com/refinedmods/refinedstorage/issues"
class="icon-link d-inline-flex align-items-center">
Refined Storage on GitHub
<i class="bi bi-chevron-right"></i>
</a>
</div>
<div class="col">
<h2 class="h4"><i class="bi bi-rss-fill"></i> Want to stay up to date?</h2>
<p>Follow us on Twitter or Mastodon to stay up to date with Refined Mods news and releases.</p>
<a href="https://twitter.com/refinedmods" class="icon-link d-inline-flex align-items-center">
Follow @refinedmods on Twitter
<i class="bi bi-chevron-right"></i>
</a>
<a href="https://anvil.social/@refinedmods" rel="me" class="icon-link d-inline-flex align-items-center">
Follow @refinedmods on Mastodon
<i class="bi bi-chevron-right"></i>
</a>
</div>
</div>
</div>
</div>
</body>
</html>
27 changes: 27 additions & 0 deletions docs/pages/need-help.adoc
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
= Need help?

== Supported versions

Before creating an issue on our issue tracker, ensure that your version is still supported.

[cols="1,1,1,1,1"]
|===
|Minecraft version|Refined Storage version range|State|New features|Bugfixes

|Minecraft 1.20.x|v1.12.x|Maintained|❌|✔️
|Minecraft 1.19.x|v1.11.x|Maintained|❌|✔️
|Minecraft 1.18.x|v1.10.x|Maintained|❌|✔️
|Minecraft 1.17.x|-|Never available|❌|❌
|Minecraft 1.16.x|v1.9.x|Unmaintained|❌|❌
|Minecraft 1.15.x|v1.8.x|Unmaintained|❌|❌
|Minecraft 1.14.x|v1.7.x |Unmaintained|❌|❌
|Minecraft 1.13.x|-|Never available|❌|❌
|Minecraft 1.12.x|v1.5.x - v1.6.x|Unmaintained|❌|❌
|Minecraft 1.11.x|v1.3.x - v1.4.x|Unmaintained|❌|❌
|Minecraft 1.10.x|v0.8.x - v1.2.x|Unmaintained|❌|❌
|Minecraft 1.9.x|v0.3.x - v0.7.x|Unmaintained|❌|❌
|Minecraft 1.8.x|-|Never available|❌|❌
|Minecraft 1.7.x|-|Never available|❌|❌
|===

Refined Storage v1.x will not be gaining new features as we are building link:https://github.com/refinedmods/refinedstorage2[Refined Storage 2].
49 changes: 49 additions & 0 deletions docs/pages/need-help.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<!DOCTYPE html>
<html layout:decorate="~{layout.html}">
<head>
<title th:utext="${title}"></title>
</head>
<body>
<div layout:fragment="content">
<main>
<div class="container bg-body-tertiary rounded-3 mb-4 mt-4 pt-4">
<div class="row g-4 p-5 row-cols-1 row-cols-lg-3">
<div class="col">
<h2 class="h4"><i class="bi bi-discord"></i> Have a question?</h2>
<p>Join our Discord server for community support.</p>
<a href="https://discordapp.com/invite/VYzsydb" class="icon-link d-inline-flex align-items-center">
Join our Discord server
<i class="bi bi-chevron-right"></i>
</a>
</div>
<div class="col">
<h2 class="h4"><i class="bi bi-bug-fill"></i> Found a bug, crash or other problem?</h2>
<p>Issues can be reported on our issue tracker.</p>
<a href="https://github.com/refinedmods/refinedstorage/issues"
class="icon-link d-inline-flex align-items-center">
Refined Storage on GitHub
<i class="bi bi-chevron-right"></i>
</a>
</div>
<div class="col">
<h2 class="h4"><i class="bi bi-rss-fill"></i> Want to stay up to date?</h2>
<p>Follow us on Twitter or Mastodon to stay up to date with Refined Mods news and releases.</p>
<a href="https://twitter.com/refinedmods" class="icon-link d-inline-flex align-items-center">
Follow @refinedmods on Twitter
<i class="bi bi-chevron-right"></i>
</a>
<a href="https://anvil.social/@refinedmods" rel="me"
class="icon-link d-inline-flex align-items-center">
Follow @refinedmods on Mastodon
<i class="bi bi-chevron-right"></i>
</a>
</div>
</div>
</div>

<div th:utext="${content}" th:remove="tag">
</div>
</main>
</div>
</body>
</html>
27 changes: 1 addition & 26 deletions docs/pages/whats-new.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,26 +1 @@
= What's New

[#_version_support]
== Version support
[cols="1,1,1,1,1"]
|===
|Minecraft version|Refined Storage version range|State|New features|Bugfixes
|Minecraft 1.20.x|v1.12.x|Maintained|❌|✔️
|Minecraft 1.19.x|v1.11.x|Maintained|❌|✔️
|Minecraft 1.18.x|v1.10.x|Maintained|❌|✔️
|Minecraft 1.17.x|-|Never available|❌|❌
|Minecraft 1.16.x|v1.9.x|Unmaintained|❌|❌
|Minecraft 1.15.x|v1.8.x|Unmaintained|❌|❌
|Minecraft 1.14.x|v1.7.x |Unmaintained|❌|❌
|Minecraft 1.13.x|-|Never available|❌|❌
|Minecraft 1.12.x|v1.5.x - v1.6.x|Unmaintained|❌|❌
|Minecraft 1.11.x|v1.3.x - v1.4.x|Unmaintained|❌|❌
|Minecraft 1.10.x|v0.8.x - v1.2.x|Unmaintained|❌|❌
|Minecraft 1.9.x|v0.3.x - v0.7.x|Unmaintained|❌|❌
|Minecraft 1.8.x|-|Never available|❌|❌
|Minecraft 1.7.x|-|Never available|❌|❌
|===
Refined Storage v1.x will not be gaining new features as we are building link:https://github.com/refinedmods/refinedstorage2[Refined Storage 2].
= What's new
Loading

0 comments on commit c9e337c

Please sign in to comment.