started docs

.github/workflows/deploy.yml

@@ -1,11 +1,10 @@
+# yaml-language-server: $schema=https://json.schemastore.org/github-workflow.json
 name: Deploy to GitHub Pages
 
 on:
   push:
     branches:
       - main
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
 
 jobs:
   build:

.github/workflows/test-deploy.yml

@@ -4,8 +4,6 @@ on:
   pull_request:
     branches:
       - main
-    # Review gh actions docs if you want to further define triggers, paths, etc
-    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
 
 jobs:
   test-deploy:

docs/getting-started/command-syntax.md

@@ -0,0 +1,29 @@
+---
+id: command-syntax
+---
+
+# Command Syntax
+
+:::danger
+
+Do not literally type the `<>` , `[]` etc characters. They are used to denote placeholders and optional arguments.
+
+:::
+
+:::note
+
+If an option is marked dynamic, for example `<foo:dynamic>`. Then you can use dynamic values. (see [Dynamic Values](./dynamic-values))
+
+:::
+
+`<foo>` This is a required argument.
+
+`<foo|bar>` This is a required agrgument that can be either `foo` or `bar`.
+
+`<foos...>` This is a required agrgument that can be repeated multiple times.
+
+`[foo]` This is an optional argument.
+
+`[foo|bar]` This is an optional argument that can be either `foo` or `bar`.
+
+`[foo=default]` This is an optional argument with a default value of `default`.

docs/getting-started/dynamic-values.md

@@ -0,0 +1,27 @@
+# Dynamic Values
+Throughout these docs you will see some values in a format that will look something like this `{user:username}`. These are dynamic values.
+
+:::danger
+
+Not all command support these values, so make sure it says you can use a dynamic value.
+
+:::
+
+## Where To Use
+You can use these values in any option that has a `:dynamic` in it. For example `<foo:dynamic>`.
+
+## How To Use
+These values are based off of discord values, for example if you wanted to mention a user when they leveled up you could use `{user:mention}`
+
+## Values
+
+### User Values
+
++ `{user:username}` The user's username
++ `{user:mention}` Mentions the user
++ `{user:nickname}` The user's nickname
+
+### Levels Values
+
++ `{user:level}` The user's level
++ `{user:xp}` The user's xp

docs/levels/disable.md

@@ -0,0 +1,17 @@
+# Disable Levels
+
+:::note
+
+This command will not work if levels are already disabled on you server
+
+:::
+
+
+## Usage
+`/levels disable`  Disables levels on your server.
+
+:::warning
+
+This command does not delete any leveling related data, it just makes it so that the leveling system for you server is disabled. To delete leveling data see [deleting you data](../delete-my-data/levels)
+
+:::

docs/levels/enable.md

@@ -0,0 +1,25 @@
+
+# Enbale Levels
+
+:::note
+
+This command will not work if levels are already enbaled on you server
+
+:::
+
+## Usage
+`/levels enable`  Enableds levels on your server and sets up with the default config
+
+## Default Config
+### Level Up Message
+Congratulations `{user:mention}` you have leveled up to level `{user:level}`!\
+You can change this with  [`/levels set-message`](./set-message)\
+You can also disable level up messages with [`/levels disabled-message`](./disable-message)
+
+### Level Up Channel
+By default the level up messages will be sent in the channel that the user levels up in.\
+You can change this with [`/levels set-message-channel`](./set-message-channle)
+
+### Stack Rewards
+By default it sets this to true, which means that as a user gets a new level reward they will keep the old ones they have earned.\
+You can change this with [`/levels stack-rewards`](./stack-rewards)

docusaurus.config.ts

@@ -56,7 +56,7 @@ const config: Config = {
       items: [
         {
           type: "docSidebar",
-          sidebarId: "tutorialSidebar",
+          sidebarId: "docs",
           position: "left",
           label: "Docs",
         },

sidebars.ts

@@ -1,4 +1,4 @@
-import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+import type { SidebarsConfig } from "@docusaurus/plugin-content-docs";
 
 /**
  * Creating a sidebar enables you to:
@@ -11,21 +11,18 @@ import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
  Create as many sidebars as you want.
  */
 const sidebars: SidebarsConfig = {
-  // By default, Docusaurus generates a sidebar from the docs folder structure
-  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
-
-  // But you can create a sidebar manually
-  /*
-  tutorialSidebar: [
-    'intro',
-    'hello',
+  docs: [
+    {
+      type: "category",
+      label: "Getting Started",
+      items: ["getting-started/command-syntax", "getting-started/dynamic-values"],
+    },
     {
-      type: 'category',
-      label: 'Tutorial',
-      items: ['tutorial-basics/create-a-document'],
+      type: "category",
+      label: "Levels",
+      items: ["levels/enable", "levels/disable"],
     },
   ],
-   */
 };
 
 export default sidebars;