improv a lot

BEComTweaks · Jan 10, 2025 · 5744572 · 5744572
1 parent eb89f04
commit 5744572
Show file tree

Hide file tree

Showing 11 changed files with 147 additions and 137 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -37,6 +37,12 @@ export default defineConfig({
           { text: 'New Compatibility', link: 'new/new-compatibility' },
         ]
       },
+      {
+        text: 'Now what?',
+        items: [
+          { text: 'Now what?', link: 'getting-started/afterwards'}
+        ]
+      },
       {
         text: 'Scripts',
         items: [

diff --git a/docs/.vitepress/theme/components/Pages.vue b/docs/.vitepress/theme/components/Pages.vue
@@ -0,0 +1,69 @@
+<template>
+    <div class="pager">
+      <a :class="['VPLink', 'link', 'pager-link', direction]" :href="link">
+        <span class="desc">{{ desc }}</span>
+        <span class="title">{{ title }}</span>
+      </a>
+    </div>
+  </template>
+
+  <script setup>
+  const props = defineProps({
+    direction: {
+      type: String,
+      required: true,
+      validator: value => ['next', 'prev'].includes(value)
+    },
+    link: {
+      type: String,
+      required: true
+    },
+    desc: {
+      type: String,
+      required: true
+    },
+    title: {
+      type: String,
+      required: true
+    }
+  });
+  </script>
+
+  <style scoped>
+  .pager {
+    display: block;
+    border: 1px solid var(--vp-c-divider);
+    border-radius: 8px;
+    padding: 11px 16px 13px;
+    width: 100%;
+    &:hover {
+        border-color: var(--vp-c-brand-1);
+    }
+  }
+  
+  .pager-link {
+    display: flex;
+    flex-direction: column;
+    text-decoration: none;
+    color: var(--vp-c-text);
+  }
+  
+  .pager-link.next {
+    align-items: flex-end;
+  }
+  
+  .pager-link.prev {
+    align-items: flex-start;
+  }
+  
+  .desc {
+    font-size: 12px;
+    color: var(--vp-c-text-2);
+  }
+  
+  .title {
+    font-size: 1.25rem;
+    font-weight: bold;
+    color: var(--vp-c-brand-1);
+  }
+  </style>
diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -5,6 +5,7 @@ import DefaultTheme from 'vitepress/theme'
 import './style.css'
 import Contributors from './components/Contributors.vue';
 import 'virtual:group-icons.css';
+import PageButton from './components/Pages.vue';
 
 export default {
   extends: DefaultTheme,
@@ -15,5 +16,6 @@ export default {
   },
   enhanceApp({ app, router, siteData }) {
     app.component('Contributors', Contributors);
+    app.component('PageButton', PageButton);
   }
 } satisfies Theme
diff --git a/docs/getting-started/afterwards.md b/docs/getting-started/afterwards.md
@@ -1,7 +1,6 @@
 ---
-prev:
-    text: New pack
-    link: new/new-pack
+prev: false
+next: false
 mentions:
   - NSPC911
 ---
@@ -29,4 +28,11 @@ Now that you have created a new category/pack, what do you do now?
 
     Open it and maybe you might get your first contribution!
 
-<Contributors />
+<Contributors />
+---
+<h3 style="margin-top: -10px !important; margin-bottom: 10px;">Other Pages</h3>
+<div style="display: grid; gap: 10px; grid-template-columns: auto-fit">
+    <PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
+    <PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
+    <PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
+</div>
diff --git a/docs/getting-started/setting-up.md b/docs/getting-started/setting-up.md
@@ -1,7 +1,5 @@
 ---
-prev:
-    text: Home
-    link: index
+prev: false
 next: false
 mentions:
   - NSPC911
@@ -31,4 +29,10 @@ You will need
 
 That's it!
 
-<Contributor/>
+<Contributor/>
+---
+<div style="display: grid; gap: 10px; grid-template-columns: auto-fit">
+  <PageButton direction="next" link="../new/new-compatibility" desc="Next page" title="Creating a new Compatibility" />
+  <PageButton direction="next" link="../new/new-pack" desc="Next page" title="Creating a new Pack" />
+  <PageButton direction="next" link="../new/new-category" desc="Next page" title="Creating a new Category" />
+</div>
diff --git a/docs/new/new-category.md b/docs/new/new-category.md
@@ -1,10 +1,6 @@
 ---
-prev:
-    text: Setting up
-    link: getting-started/setting-up
-next:
-    text: Creating a new Pack
-    link: new/new-pack
+prev: false
+next: false
 mentions:
   - NSPC911
 ---
@@ -118,4 +114,14 @@ const listofcategories
 ### Create a pack
 Now that your category is set, maybe create a new pack? If so, refer to [`Create a new pack`](new-pack)
 
-<Contributors />
+<Contributors />
+---
+<div style="display: flex; justify-content: space-between; gap: 10px" >
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
+    <PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
+    <PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
+  </div>
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
+    <PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
+  </div>
+</div>
diff --git a/docs/new/new-compatibility.md b/docs/new/new-compatibility.md
@@ -1,10 +1,6 @@
 ---
-prev:
-    text: Setting up
-    link: getting-started/setting-up
-next:
-    text: Creating a new Pack
-    link: new/new-pack
+prev: false
+next: false
 mentions:
   - NSPC911
 ---
@@ -60,13 +56,31 @@ Say you want to add a 4 way compatibility while using the example `compatibility
 2. Create a new key called `4way`
 
    Here is how the key would look like
-  ```json [jsons/packs/compatibility.json]
-"2way": {
+```json [jsons/packs/compatibility.json]
+"4way": {
 	"compatibilities": [
 		["packid1", "packid2", "packid3", "packid4"]
 	],
 	"locations": [
 	  "compatibility/packid1234"
 	]
 }
-	```
+```
+- The `compatibility` key contains the list of packs with compatibilities within each other
+- The `locations` key contains their  respective location with respective from `./packs`
+	- In this case, the location is `compatibility/packid1234`, so it will be located at `packs/compatibility/packid1234`
+
+If you are making an n-way compatibility where `n` is lesser than `maxway`, then you can just add onto the existing `n-way` key
+
+That should be about it!
+<Contributors/>
+---
+<div style="display: flex; justify-content: space-between; gap: 10px" >
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
+    <PageButton direction="prev" link="../new/new-pack" desc="Previous page" title="Creating a new Pack" />
+    <PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
+  </div>
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
+    <PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
+  </div>
+</div>
diff --git a/docs/new/new-pack.md b/docs/new/new-pack.md
@@ -1,10 +1,6 @@
 ---
-prev:
-    text: Setting up
-    link: getting-started/setting-up
-next:
-    text: What next?
-    link: getting-started/afterwards
+prev: false
+next: false
 mentions:
   - NSPC911
 ---
@@ -143,5 +139,14 @@ You can start adding the files!
 If you are using a build script, you will need to create another directory to house the 'raw' files, add the script and its corresponding key in the pack's JSON (refer above)
 
 An example script is available in <kbd>./pys/example_builder.py</kbd>
-
-<Contributors />
+<Contributors/>
+---
+<div style="display: flex; justify-content: space-between; gap: 10px" >
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1;">
+    <PageButton direction="prev" link="../new/new-compatibility" desc="Previous page" title="Creating a new Compatibility" />
+    <PageButton direction="prev" link="../new/new-category" desc="Previous page" title="Creating a new Category" />
+  </div>
+  <div style="display: flex; flex-direction: column; gap: 10px; flex: 1; align-items: flex-end;">
+    <PageButton direction="next" link="../getting-started/afterwards" desc="Next page" title="Now what?" />
+  </div>
+</div>
diff --git a/docs/scripts/js-files.md b/docs/scripts/js-files.md
diff --git a/docs/scripts/py-files.md b/docs/scripts/py-files.md
diff --git a/docs/to-do.md b/docs/to-do.md
@@ -10,9 +10,9 @@ Stuff to do or in progress.<br>Feel free to help me with these!
 	- Make a proper footer aside from the credits footer
  - Make an easily accessible console log like in [BEComTweaks/btrp-updater](https://github.com/BEComTweaks/btrp-updater)
  - Move away from a server to full frontend
-  - Resource Packs
-  - Behaviour Packs [`no-backend`](https://github.com/BEComTweaks/behaviour-packs/tree/no-backend)
-  - Crafting Tweaks
+    - Resource Packs
+    - Behaviour Packs [`no-backend`](https://github.com/BEComTweaks/behaviour-packs/tree/no-backend)
+    - Crafting Tweaks
 - docs
 	- Finish it up! <!--too lazy-->