docs preview

Aspecky · Jan 11, 2024 · 03819d8 · 03819d8
1 parent 02ee277
commit 03819d8
Show file tree

Hide file tree

Showing 10 changed files with 100 additions and 150 deletions.
diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs
@@ -3,24 +3,36 @@ import { defineConfig } from 'vitepress'
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
   title: "LuauEvent",
-  description: "This is the description",
   base: "/LuauEvent/",
+  lang: 'en-US',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
-      { text: 'Home', link: '/' },
-      { text: 'Examples', link: '/markdown-examples' }
+      { text: 'Into', link: '/intro/introduction' },
+      { text: 'API Reference', link: '/classes/bindable' }
     ],
 
-    sidebar: [
-      {
-        text: 'Examples',
-        items: [
-          { text: 'Markdown Examples', link: '/markdown-examples' },
-          { text: 'Runtime API Examples', link: '/api-examples' }
-        ]
-      }
-    ],
+    sidebar: {
+      '/intro/': [
+        {
+          text: 'Introduction',
+          items: [
+            { text: 'Description', link: '/intro/introduction' },
+            { text: 'Features', link: '/intro/features' }
+          ]
+        },
+      ],
+      '/classes/': [
+        {
+          text: 'Classes',
+          items: [
+            { text: 'Bindable', link: '/classes/bindable' },
+            { text: 'Signal', link: '/classes/signal' },
+            { text: 'Connection', link: '/classes/connection' },
+          ]
+        },
+      ],
+    },
 
     socialLinks: [
       { icon: 'github', link: 'https://github.com/Aspecky/LuauEvent' }

diff --git a/docs/api-examples.md b/docs/api-examples.md
diff --git a/docs/classes/bindable.md b/docs/classes/bindable.md
@@ -0,0 +1,29 @@
+---
+outline: deep
+---
+
+# Bindable
+```lua
+type Event<T...> = {
+	Signal: Signal<T...>,
+	RBXScriptConnection: RBXScriptConnection?,
+
+	Fire: (self: Event<T...>, T...) -> (),
+	DisconnectAll: (self: Event<T...>) -> (),
+	Destroy: (self: Event<T...>) -> (),
+}
+```
+
+## Properties
+
+### Signal
+
+### RBXScriptConnection
+
+## Methods
+
+### Fire
+
+### DisconnectAll
+
+### Destroy
diff --git a/docs/classes/connection.md b/docs/classes/connection.md
@@ -0,0 +1,23 @@
+---
+outline: deep
+---
+
+# Connection
+
+```lua
+type Connection<U...> = {
+	Connected: boolean,
+	Disconnect: (self: Connection<U...>) -> (),
+	Reconnect: (self: Connection<U...>) -> (),
+}
+```
+
+## Properties
+
+### Connected
+
+## Methods
+
+### Disconnect
+
+### Reconnect
diff --git a/docs/classes/signal.md b/docs/classes/signal.md
@@ -0,0 +1,20 @@
+---
+outline: deep
+---
+
+# Signal
+```lua
+type Signal<T...> = {
+	Connect: <U...>(self: Signal<T...>, fn: (...unknown) -> (), U...) -> Connection<U...>,
+	Once: <U...>(self: Signal<T...>, fn: (...unknown) -> (), U...) -> Connection<U...>,
+	Wait: (self: Signal<T...>) -> T...,
+}
+```
+
+## Methods
+
+### Connect
+
+### Once
+
+### Wait
diff --git a/docs/index.md b/docs/index.md
@@ -3,9 +3,8 @@
 layout: home
 
 hero:
-  name: "LuauEvent"
-  text: "LuauEvent"
-  tagline: My great project tagline
+  text: LuauEvent
+  tagline: A highly optimized Luau implementation of BindableEvent
   actions:
     - theme: brand
       text: Markdown Examples
@@ -15,7 +14,7 @@ hero:
       link: /api-examples
 
 features:
-  - title: Feature A
+  - title: ⚡ Optimized
     details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
   - title: Feature B
     details: Lorem ipsum dolor sit amet, consectetur adipiscing elit

diff --git a/docs/intro/features.md b/docs/intro/features.md
diff --git a/docs/intro/introduction.md b/docs/intro/introduction.md
@@ -0,0 +1 @@
+# Why?
diff --git a/docs/intro/performance.md b/docs/intro/performance.md
diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md