📦 add docs for chemical washer, combiner, crusher; refactor Mekanism …

…doc template
cyberbit · Aug 3, 2024 · 764df86 · 764df86
1 parent a952671
commit 764df86
Show file tree

Hide file tree

Showing 20 changed files with 448 additions and 817 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -69,11 +69,11 @@ export default defineConfig({
               { text: 'Chemical Injection Chamber', link: '/reference/input/mekanism/ChemicalInjectionChamber' },
               { text: 'Chemical Oxidizer', link: '/reference/input/mekanism/ChemicalOxidizer' },
               { text: 'Chemical Tank', link: '/reference/input/mekanism/ChemicalTank' },
-              // { text: 'Chemical Washer', link: '/reference/input/mekanism/ChemicalWasher' },
-              // { text: 'Combiner', link: '/reference/input/mekanism/Combiner' },
+              { text: 'Chemical Washer', link: '/reference/input/mekanism/ChemicalWasher' },
+              { text: 'Combiner', link: '/reference/input/mekanism/Combiner' },
               // { text: 'Combining Factory', link: '/reference/input/mekanism/CombiningFactory' },
               // { text: 'Compressing Factory', link: '/reference/input/mekanism/CompressingFactory' },
-              // { text: 'Crusher', link: '/reference/input/mekanism/Crusher' },
+              { text: 'Crusher', link: '/reference/input/mekanism/Crusher' },
               // { text: 'Crushing Factory', link: '/reference/input/mekanism/CrushingFactory' },
               // { text: 'Digital Miner', link: '/reference/input/mekanism/DigitalMiner' },
               // { text: 'Dynamic Tank', link: '/reference/input/mekanism/DynamicTank' },

diff --git a/docs/reference/input/mekanism/AntiprotonicNucleosynthesizer.md b/docs/reference/input/mekanism/AntiprotonicNucleosynthesizer.md
@@ -1,58 +1,18 @@
+---
+telem:
+  adapter:
+    id: 'apns'
+    name: 'Antiprotonic Nucleosynthesizer'
+    categories: '{ "basic", "advanced", "input", "output", "energy", "recipe" }'
+---
+
 <script setup>
   import { data as metrics } from './common/metrics.data.ts'
 </script>
 
 # Mekanism Antiprotonic Nucleosynthesizer Input <RepoLink path="lib/input/mekanism/AntiprotonicNucleosynthesizerInputAdapter.lua" />
 
-```lua
-telem.input.mekanism.apns (
-	peripheralID: string,
-	categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Mekanism**.
-:::
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Antiprotonic Nucleosynthesizer'
-    },
-		{
-			name: 'categories',
-			type: 'string[] | &quot;*&quot;',
-			default: '{ &quot;basic&quot; }'
-		}
-  ]"
->
-<template v-slot:categories>
-
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic", "advanced", "input", "output", "energy", "recipe" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
-
-local backplane = telem.backplane()
-  :addInput('my_apns', telem.input.mekanism.apns('right', '*'))
-  :cycleEvery(5)()
-```
-
-Given an Antiprotonic Nucleosynthesizer peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity):
+<!--@include: ./common/preamble.md -->
 
 ### Basic
 

diff --git a/docs/reference/input/mekanism/Bin.md b/docs/reference/input/mekanism/Bin.md
@@ -1,54 +1,14 @@
-# Mekanism Bin Input <RepoLink path="lib/input/mekanism/BinInputAdapter.lua" />
-
-```lua
-telem.input.mekanism.bin (
-	peripheralID: string,
-	categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Mekanism**.
-:::
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Bin'
-    },
-		{
-			name: 'categories',
-			type: 'string[] | &quot;*&quot;',
-			default: '{ &quot;basic&quot; }'
-		}
-  ]"
->
-<template v-slot:categories>
+---
+telem:
+  adapter:
+    id: 'bin'
+    name: 'Bin'
+    categories: '{ "basic" }'
+---
 
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
-
-local backplane = telem.backplane()
-  :addInput('my_bin', telem.input.mekanism.bin('right', '*'))
-  :cycleEvery(5)()
-```
+# Mekanism Bin Input <RepoLink path="lib/input/mekanism/BinInputAdapter.lua" />
 
-Given a Bin peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity):
+<!--@include: ./common/preamble.md -->
 
 ### Basic
 

diff --git a/docs/reference/input/mekanism/BioGenerator.md b/docs/reference/input/mekanism/BioGenerator.md
@@ -1,58 +1,19 @@
+---
+telem:
+  adapter:
+    id: 'bioGenerator'
+    name: 'Bio Generator'
+    categories: '{ "basic", "advanced", "fuel", "energy" }'
+    requiresMekGen: true
+---
+
 <script setup>
   import { data as metrics } from './common/metrics.data.ts'
 </script>
 
 # Mekanism Bio Generator Input <RepoLink path="lib/input/mekanism/BioGeneratorInputAdapter.lua" />
 
-```lua
-telem.input.mekanism.bioGenerator (
-	peripheralID: string,
-	categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Mekanism** and **Mekanism Generators**.
-:::
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Bio Generator'
-    },
-		{
-			name: 'categories',
-			type: 'string[] | &quot;*&quot;',
-			default: '{ &quot;basic&quot; }'
-		}
-  ]"
->
-<template v-slot:categories>
-
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic", "advanced", "fuel", "energy" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
-
-local backplane = telem.backplane()
-  :addInput('my_biogen', telem.input.mekanism.bioGenerator('right', '*'))
-  :cycleEvery(5)()
-```
-
-Given a Bio Generator peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity):
+<!--@include: ./common/preamble.md -->
 
 ### Basic
 

diff --git a/docs/reference/input/mekanism/ChemicalCrystallizer.md b/docs/reference/input/mekanism/ChemicalCrystallizer.md
@@ -1,58 +1,18 @@
+---
+telem:
+  adapter:
+    id: 'chemicalCrystallizer'
+    name: 'Chemical Crystallizer'
+    categories: '{ "basic", "advanced", "input", "output", "energy", "recipe" }'
+---
+
 <script setup>
   import { data as metrics } from './common/metrics.data.ts'
 </script>
 
 # Mekanism Chemical Crystallizer Input <RepoLink path="lib/input/mekanism/ChemicalCrystallizerInputAdapter.lua" />
 
-```lua
-telem.input.mekanism.chemicalCrystallizer (
-  peripheralID: string,
-  categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Mekanism**.
-:::
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Chemical Crystallizer'
-    },
-    {
-      name: 'categories',
-      type: 'string[] | &quot;*&quot;',
-      default: '{ &quot;basic&quot; }'
-    }
-  ]"
->
-<template v-slot:categories>
-
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic", "advanced", "input", "output", "energy", "recipe" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
-
-local backplane = telem.backplane()
-  :addInput('my_crystallizer', telem.input.mekanism.chemicalCrystallizer('right', '*'))
-  :cycleEvery(5)()
-```
-
-Given a Chemical Crystallizer peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity):
+<!--@include: ./common/preamble.md -->
 
 ### Basic
 

diff --git a/docs/reference/input/mekanism/ChemicalDissolutionChamber.md b/docs/reference/input/mekanism/ChemicalDissolutionChamber.md
@@ -1,58 +1,18 @@
+---
+telem:
+  adapter:
+    id: 'dissolutionChamber'
+    name: 'Chemical Dissolution Chamber'
+    categories: '{ "basic", "advanced", "input", "output", "energy", "recipe" }'
+---
+
 <script setup>
   import { data as metrics } from './common/metrics.data.ts'
 </script>
 
 # Mekanism Chemical Dissolution Chamber Input <RepoLink path="lib/input/mekanism/ChemicalDissolutionChamberInputAdapter.lua" />
 
-```lua
-telem.input.mekanism.dissolutionChamber (
-  peripheralID: string,
-  categories?: string[] | '*'
-)
-```
-
-::: warning Mod Dependencies
-Requires **Mekanism**.
-:::
-
-See the Usage section for a complete list of the metrics in each category.
-
-<PropertiesTable
-  :properties="[
-    {
-      name: 'peripheralID',
-      type: 'string',
-      default: 'nil',
-      description: 'Peripheral ID of the Chemical Dissolution Chamber'
-    },
-    {
-      name: 'categories',
-      type: 'string[] | &quot;*&quot;',
-      default: '{ &quot;basic&quot; }'
-    }
-  ]"
->
-<template v-slot:categories>
-
-List of metric categories to query. The value `"*"` can be used to include all categories, which are listed below.
-
-```lua
-{ "basic", "advanced", "input", "output", "energy", "recipe" }
-```
-</template>
-</PropertiesTable>
-
-## Usage
-
-```lua{4}
-local telem = require 'telem'
-
-local backplane = telem.backplane()
-  :addInput('my_dissolution', telem.input.mekanism.dissolutionChamber('right', '*'))
-  :cycleEvery(5)()
-```
-
-Given a Chemical Dissolution Chamber peripheral on the `right` side of the computer, this appends the following metrics to the backplane (grouped by category here for clarity):
+<!--@include: ./common/preamble.md -->
 
 ### Basic