📝 start of majority of writerside docs

devOS-Sanity-Edition · Aug 4, 2024 · 0be5635 · 0be5635
1 parent 10947f0
commit 0be5635
Show file tree

Hide file tree

Showing 78 changed files with 1,060 additions and 9 deletions.
diff --git a/.github/workflows/writerside.yml b/.github/workflows/writerside.yml
@@ -0,0 +1,75 @@
+name: Build documentation
+
+on:
+  push:
+    # To trigger the workflow once you push to the `main` branch
+    # Replace `main` with your branch’s name
+    branches: ["aviation"]
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  # Name of module and id separated by a slash
+  INSTANCE: Writerside/docs
+  # Replace XX with the ID of the instance in capital letters
+  ARTIFACT: webHelpDOCS2-all.zip
+  # Docker image version
+  DOCKER_VERSION: 241.18775
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+          retention-days: 7
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4.0.0
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4.0.4
diff --git a/README.md b/README.md
@@ -1,12 +1,11 @@
 # Yiski
 
-<p align="center"><img title="Yiski" width="960" alt="YiskiBanner" src="https://user-images.githubusercontent.com/30705254/145800210-a36286c0-ba38-45b6-b3ae-34e6481f9ff5.png"></p>
+<p align="center"><img title="Yiski" width="960" alt="YiskiBanner" src="https://github.com/user-attachments/assets/eff9d5f4-3736-43a5-a436-b96e5a71e36c"></p>
 
 # What is Yiski
-A bot to replace the original idea of devOS Core for the devOS: Sanity Edition server. Also used to try to learn ~~Python~~ Kotlin for fun.
-- ~~Uses Python 3.10, but 3.9+ should work.~~ Now using Kotlin!
+Yiski is an in-house developed Discord bot by devOS: Sanity Edition, with its development being lead by [asojidev](https://github.com/asoji).
 
-**This is something I'm doing just for fun and to learn ~~Python~~ Kotlin, excuse anything shitty going on.**
+Powered by [JDA](https://github.com/discord-jda/JDA), [JDA-KTX](https://github.com/minndevelopment/jda-ktx), and [CephalonCosmic](https://twitter.com/CephalonCosmic)'s [Aviation](https://gitlab.com/artrinix/discord/aviation) Framework. Kotlin too, of course.
 
 ## License
 This project is licensed under the [MIT License](LICENSE)
diff --git a/Writerside/c.list b/Writerside/c.list
@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="wrs" name="Writerside documentation" order="1"/>
+</categories>
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE buildprofiles SYSTEM "https://resources.jetbrains.com/writerside/1.0/build-profiles.dtd">
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+
+    <variables></variables>
+    <build-profile instance="docs">
+        <variables>
+            <header-logo>logo.svg</header-logo>
+            <primary-color>#00a86b</primary-color>
+            <link-color>#00a86b</link-color>
+            <noindex-content>false</noindex-content>
+            <custom-favicons>icon16.png,icon32.png,icon96.png,icon300.png,icon500.png</custom-favicons>
+        </variables>
+        <footer>
+            <copyright>2024 devOS: Sanity Edition, asojidev</copyright>
+            <link href="https://github.com/devOS-Sanity-Edition/yiski">GitHub Repo</link>
+        </footer>
+    </build-profile>
+
+</buildprofiles>
diff --git a/Writerside/docs.tree b/Writerside/docs.tree
@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE instance-profile
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
+
+<instance-profile id="docs"
+                 name="Yiski"
+                 start-page="Welcome.topic">
+
+    <toc-element topic="Welcome.topic"/>
+    <toc-element topic="Yiski.md"/>
+    <toc-element topic="Yiski-Bot-Setup.md"/>
+    <toc-element topic="Configs.topic">
+        <toc-element topic="About-Configs.md"/>
+        <toc-element topic="Runner-Config.md"/>
+        <toc-element topic="Modules-Configs.topic">
+            <toc-element topic="Yiski1-Config.md"/>
+            <toc-element topic="Yiski2-Config.md"/>
+            <toc-element topic="Yiski3-Config.md"/>
+            <toc-element topic="Yiski4-Config.md"/>
+            <toc-element topic="Yiski5-Config.md"/>
+            <toc-element topic="Yiski6-Config.md"/>
+        </toc-element>
+    </toc-element>
+    <toc-element topic="Commands.topic">
+        <toc-element topic="Yiski1-Commands.md"/>
+        <toc-element topic="Yiski2-Commands.md"/>
+        <toc-element topic="Yiski3-Commands.md"/>
+        <toc-element topic="Yiski4-Commands.md"/>
+        <toc-element topic="Yiski5-Commands.md"/>
+        <toc-element topic="Yiski6-Commands.md"/>
+    </toc-element>
+    <toc-element topic="Runner.topic" toc-title="Runner"></toc-element>
+    <toc-element topic="Modules.topic" toc-title="Modules"></toc-element>
+    <toc-element topic="Modules-Loader.topic" toc-title="Modules Loader"></toc-element>
+    <toc-element toc-title="GitHub Repo" href="https://github.com/devOS-Sanity-Edition/Yiski"></toc-element>
+</instance-profile>
diff --git a/Writerside/images/antihorny.mp4 b/Writerside/images/antihorny.mp4
diff --git a/Writerside/images/antihornythumbnail.png b/Writerside/images/antihornythumbnail.png
diff --git a/Writerside/images/completion_procedure.png b/Writerside/images/completion_procedure.png
diff --git a/Writerside/images/completion_procedure_dark.png b/Writerside/images/completion_procedure_dark.png
diff --git a/Writerside/images/convert_table_to_xml.png b/Writerside/images/convert_table_to_xml.png
diff --git a/Writerside/images/convert_table_to_xml_dark.png b/Writerside/images/convert_table_to_xml_dark.png
diff --git a/Writerside/images/devtoolsconfig.png b/Writerside/images/devtoolsconfig.png
diff --git a/Writerside/images/dreadfulims.png b/Writerside/images/dreadfulims.png
diff --git a/Writerside/images/gasp.mp4 b/Writerside/images/gasp.mp4
diff --git a/Writerside/images/gaspthumbnail.png b/Writerside/images/gaspthumbnail.png
diff --git a/Writerside/images/headcrab_fail.gif b/Writerside/images/headcrab_fail.gif
diff --git a/Writerside/images/icon16.png b/Writerside/images/icon16.png
diff --git a/Writerside/images/icon300.png b/Writerside/images/icon300.png
diff --git a/Writerside/images/icon32.png b/Writerside/images/icon32.png
diff --git a/Writerside/images/icon500.png b/Writerside/images/icon500.png
diff --git a/Writerside/images/icon96.png b/Writerside/images/icon96.png
diff --git a/Writerside/images/logo.svg b/Writerside/images/logo.svg
diff --git a/Writerside/images/memoryleak.mp4 b/Writerside/images/memoryleak.mp4
diff --git a/Writerside/images/memoryleakthumbnail.png b/Writerside/images/memoryleakthumbnail.png
diff --git a/Writerside/images/new_topic_options.png b/Writerside/images/new_topic_options.png
diff --git a/Writerside/images/new_topic_options_dark.png b/Writerside/images/new_topic_options_dark.png
diff --git a/Writerside/images/rtx.mp4 b/Writerside/images/rtx.mp4
diff --git a/Writerside/images/rtxthumbnail.png b/Writerside/images/rtxthumbnail.png
diff --git a/Writerside/images/setup_0.png b/Writerside/images/setup_0.png
diff --git a/Writerside/images/setup_1.png b/Writerside/images/setup_1.png
diff --git a/Writerside/images/setup_10.png b/Writerside/images/setup_10.png
diff --git a/Writerside/images/setup_11.png b/Writerside/images/setup_11.png
diff --git a/Writerside/images/setup_12.png b/Writerside/images/setup_12.png
diff --git a/Writerside/images/setup_13.png b/Writerside/images/setup_13.png
diff --git a/Writerside/images/setup_14.png b/Writerside/images/setup_14.png
diff --git a/Writerside/images/setup_15.png b/Writerside/images/setup_15.png
diff --git a/Writerside/images/setup_16.png b/Writerside/images/setup_16.png
diff --git a/Writerside/images/setup_17.png b/Writerside/images/setup_17.png
diff --git a/Writerside/images/setup_18.png b/Writerside/images/setup_18.png
diff --git a/Writerside/images/setup_19.png b/Writerside/images/setup_19.png
diff --git a/Writerside/images/setup_2.png b/Writerside/images/setup_2.png
diff --git a/Writerside/images/setup_20.png b/Writerside/images/setup_20.png
diff --git a/Writerside/images/setup_3.png b/Writerside/images/setup_3.png
diff --git a/Writerside/images/setup_4.png b/Writerside/images/setup_4.png
diff --git a/Writerside/images/setup_5.png b/Writerside/images/setup_5.png
diff --git a/Writerside/images/setup_6.png b/Writerside/images/setup_6.png
diff --git a/Writerside/images/setup_7.png b/Writerside/images/setup_7.png
diff --git a/Writerside/images/setup_8.png b/Writerside/images/setup_8.png
diff --git a/Writerside/images/setup_9.png b/Writerside/images/setup_9.png
diff --git a/Writerside/images/token.png b/Writerside/images/token.png
diff --git a/Writerside/images/whatareyoudoing.mp4 b/Writerside/images/whatareyoudoing.mp4
diff --git a/Writerside/images/whatareyoudoingthumbnail.png b/Writerside/images/whatareyoudoingthumbnail.png
diff --git a/Writerside/images/yiski_banner.png b/Writerside/images/yiski_banner.png
diff --git a/Writerside/images/yiski_name_origin.png b/Writerside/images/yiski_name_origin.png
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
+<rules>
+    <!-- format is as follows
+    <rule id="<unique id>">
+        <accepts>page.html</accepts>
+    </rule>
+    -->
+    <rule id="7c0e0e95">
+        <description>Created after removal of "Section Starting Page" from Yiski</description>
+        <accepts>Section-Starting-Page.html</accepts>
+    </rule>
+    <rule id="2111a8d">
+        <description>Created after removal of "How to" from Yiski</description>
+        <accepts>How-to.html</accepts>
+    </rule>
+    <rule id="207e4837">
+        <description>Created after removal of "Reference" from Yiski</description>
+        <accepts>Reference.html</accepts>
+    </rule>
+</rules>
diff --git a/Writerside/topics/About-Configs.md b/Writerside/topics/About-Configs.md
@@ -0,0 +1,23 @@
+# About Configs
+
+## Why are these configs needed?
+
+### Short Answer:
+
+<tldr>
+Each modules does different things and has different values, best to provide each module with its own file for its own values.
+</tldr>
+
+### Long answer:
+Each seperate module has its own configuration file, due to how they work, it's best to not merge all the configurations all into one file.
+Having a seperate configuration file for each module provides a bit of flexibility and avoids values from stepping on each other, and be configured for their exact use case.
+All configuration files by default are TOML in this codebase, being powered by [KToml](https://github.com/orchestr7/ktoml).
+
+## Does each module require its own config?
+
+With how Yiski is designed, yes, however, a module can also opt out from having a config at all by having the module's developer not fill in the `configClass` line in their metadata.
+It is however recommended that each module does have a config file that can be adjusted.
+
+## Does every value have to be filled in?
+
+If the value is not said to be optional by the module dev, then automatically assume that it is required.
diff --git a/Writerside/topics/Commands.topic b/Writerside/topics/Commands.topic
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
+<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
+       title="Commands" id="Commands">
+
+    <section-starting-page>
+        <title>Commands</title>
+        <description>
+            Look through all the modules and what commands they provide.
+        </description>
+
+        <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
+        <spotlight>
+            <a href="" type="account" summary="Basic commands and Moderation">Yiski1</a>
+            <a href="" type="search" summary="Fun">Yiski3</a>
+        </spotlight>
+
+        <!--    Add several topics that are most important for this section.    -->
+        <primary>
+            <title>Get started</title>
+            <a href=""/>
+            <a href="" summary="With a custom card summary"/>
+            <a href="">Custom card title</a>
+            <a href="" summary="With a custom card summary">Custom card title</a>
+        </primary>
+
+        <!--    Add several topics that are less important or are relevant only for advanced/experienced users.    -->
+        <secondary>
+            <title>Explore advanced features</title>
+            <a href=""/>
+            <a href="" summary="With a custom card summary"/>
+            <a href="">Custom card title</a>
+            <a href="" summary="With a custom card summary">Custom card title</a>
+        </secondary>
+
+        <!--    Optionally add additional cards and links to topics that are not in this section but may be relevant.    -->
+        <misc>
+            <cards>
+                <title>Other relevant topics as wide cards</title>
+                <a href=""/>
+                <a href="" summary="With a custom card summary"/>
+                <a href="">Custom card title</a>
+                <a href="" summary="With a custom card summary">Custom card title</a>
+            </cards>
+
+            <cards narrow="true">
+                <title>Other relevant topics as narrow cards</title>
+                <a href=""/>
+                <a href=""/>
+                <a href="" summary="With a custom card summary"/>
+                <a href="">Custom card title</a>
+                <a href="">Custom card title</a>
+                <a href="" summary="With a custom card summary">Custom card title</a>
+            </cards>
+
+            <links>
+                <group>
+                    <title>Other related topics as links</title>
+                    <a href=""/>
+                    <a href="" summary="With a custom card summary"/>
+                    <a href="">Custom card title</a>
+                    <a href="" summary="With a custom card summary">Custom card title</a>
+                </group>
+                <group>
+                    <title>Two in a row</title>
+                    <a href=""/>
+                    <a href="" summary="With a custom card summary"/>
+                    <a href="">Custom card title</a>
+                    <a href="" summary="With a custom card summary">Custom card title</a>
+                </group>
+            </links>
+
+            <links narrow="true">
+                <group>
+                    <title>More related topics</title>
+                    <a href=""/>
+                    <a href="" summary="With a custom card summary"/>
+                    <a href="">Custom card title</a>
+                    <a href="" summary="With a custom card summary">Custom card title</a>
+                </group>
+                <group>
+                    <title>Three in a row</title>
+                    <a href=""/>
+                    <a href=""/>
+                    <a href="">Custom card title</a>
+                    <a href="">Custom card title</a>
+                </group>
+                <group>
+                    <title>Each group is narrow</title>
+                    <a href=""/>
+                    <a href=""/>
+                    <a href="">Custom card title</a>
+                    <a href="">Custom card title</a>
+                </group>
+            </links>
+        </misc>
+    </section-starting-page>
+
+</topic>
diff --git a/Writerside/topics/Configs.topic b/Writerside/topics/Configs.topic
@@ -0,0 +1,37 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE topic
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
+<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+       xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
+       title="Configs" id="Configs">
+
+    <section-starting-page>
+        <title>Configuration</title>
+        <description>
+            Here is all the configuration files you need to run Yiski. Most are pretty simple to fill and some are just a copy n' paste.
+        </description>
+
+        <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
+        <spotlight>
+            <a href="About-Configs.md" type="search" summary="What are all of these configurations? Why are they needed?">About</a>
+            <a href="Runner-Config.md" type="documents" summary="The most important configuration you need to fill out">Runner</a>
+        </spotlight>
+
+        <!--    Add several topics that are most important for this section.    -->
+        <primary>
+            <title>Modules Configurations</title>
+            <a href="Yiski1-Config.md" summary="Configuration for Yiski1">Yiski1</a>
+            <a href="Yiski2-Config.md" summary="Configuration for Yiski2">Yiski2</a>
+            <a href="Yiski4-Config.md" summary="Configuration for Yiski4">Yiski4</a>
+            <a href="Yiski5-Config.md" summary="Configuration for Yiski5">Yiski5</a>
+            <a href="Yiski6-Config.md" summary="Configuration for Yiski6">Yiski6</a>
+        </primary>
+
+        <!--    Add several topics that are less important or are relevant only for advanced/experienced users.    -->
+        <secondary>
+            <title>Copy n' Paste Module Configurations</title>
+            <a href="Yiski3-Config.md" summary="Configuration for Yiski3">Yiski3</a>
+        </secondary>
+    </section-starting-page>
+
+</topic>