update docs

lumin-org · Apr 29, 2024 · d48390c · d48390c
1 parent 072b3d4
commit d48390c
Show file tree

Hide file tree

Showing 18 changed files with 72 additions and 187 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -41,7 +41,7 @@ export default defineConfig({
         {
           text: 'Engine Recaps',
           items: [
-            { text: 'May 2024', link: '/recaps/' },
+            { text: 'April 2024', link: '/recaps/' },
             { text: 'February 2024', link: '/recaps/february2024' },
             { text: 'December 2023', link: '/recaps/december2023' },
             { text: 'November 2023', link: '/recaps/november2023' },
@@ -79,20 +79,7 @@ export default defineConfig({
                 { text: 'ClientFunction', link: '/api/network/client/function' },
                 { text: 'ServerFunction', link: '/api/network/server/function' }
               ]
-            },
-
-            {
-              text: 'Runtime',
-              collapsed: true,
-              items: [
-                { text: 'Runtime', link: '/api/runtime' },
-                { text: 'RuntimeSettings', link: '/api/runtime/settings' },
-                { text: 'RuntimeObjects', link: '/api/runtime/objects' }
-              ]
-            },
-
-            { text: 'Debugger', link: '/api/debugger' },
-            { text: 'Event', link: '/api/event' }
+            }
           ]
         },
       ],

diff --git a/docs/api/dependencies/engineloader.md b/docs/api/dependencies/engineloader.md
diff --git a/docs/api/index.md b/docs/api/index.md
@@ -4,11 +4,11 @@ The main class of LuminFramework.
 
 ## Properties
 
-### Runtime <Badge type="tip" text="read only" />
+### Promise <Badge type="tip" text="read only" />
 
-The runtime property contains settings that are set during runtime, and the current context of the server/client.
+A reference to evaera's Promise module.
 
-* [**Runtime**](/api/runtime/)
+* [**Promise**](https://eryn.io/roblox-lua-promise/)
 
 ## Functions
 
@@ -34,15 +34,15 @@ Gets the client-sided interface of LuminFramework.
 
 ### Load
 
-Imports the provided packages in chronological order, also allowing for you to import descendants aswell. Non-modules will be filtered out automatically.
+Imports any modules of the parent provided. Non-modules will be filtered out automatically.
 
 **Parameters**
 
-* **importList:** `{ModuleScript}`\
-A list of packages to import
+* **parent:** `Instance`\
+The parent of which the modules are located
 
-* **importDeep:** `boolean?`\
-Whether or not to import the package's descendants, defaults to `false`
+* **filter:** `(module: ModuleScript) -> boolean?`\
+Allows you to filter through a module, return `false` for it to not be imported
 
 **Returns**
 
@@ -52,13 +52,13 @@ Whether or not to import the package's descendants, defaults to `false`
 
 ### Signal
 
-Creates/reference a event of the given name, create a new anonymous event by leaving the name blank.
+Creates/references a signal of the given name, create a new anonymous signal by leaving the name blank.
 
 **Parameters**
 
 * **name:** `string?`\
-The name of the event
+The name of the signal
 
 **Returns**
 
-* [**Event**](/api/event)
+* [**Signal**](https://sleitnick.github.io/RbxUtil/api/Signal/)
diff --git a/docs/guides/debugging.md b/docs/guides/debugging.md
diff --git a/docs/guides/events.md b/docs/guides/events.md
diff --git a/docs/guides/index.md b/docs/guides/index.md
@@ -8,10 +8,4 @@ You must you use a server script to start the framework or else unexpected event
 
 ### Initialize the Framework
 
-Initializing the framework is as simple as requiring the main module and you are done. Once you do this, you may see a few things in the output.
-
-![Setup example image](images/setupexample.png)
-
-You will see the above for both the client and the server. This is the amount of time it took for the framework to start up, in milliseconds. If you want to benchmark further, this API is available on the main module, `LoadTime`.
-
-And that's about it! Moving on to the next guides should be easy from here. 
+Initializing the framework is as simple as requiring the main module and you are done. Moving on to the next guides should be easy from here. 
diff --git a/docs/installation.md b/docs/installation.md
@@ -9,5 +9,5 @@
 ### Wally
 
 1. Create a new Git project or open one
-2. Add `lumin/framework@^7.0.0` to your `wally.toml` file
+2. Add `lumin/framework@^8.0.0` to your `wally.toml` file
 3. Run `wally install` and LuminFramework should be inside of your `/Packages` directory.
diff --git a/docs/recaps/august2023.md b/docs/recaps/august2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - August 2023
+# Recap - August 2023
 August 24, 2023 · 2 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/december2023.md b/docs/recaps/december2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - December 2023
+# Recap - December 2023
 December 27, 2023 · 1 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/february2024.md b/docs/recaps/february2024.md
@@ -0,0 +1,30 @@
+# Recap - February 2024
+March 1, 2024 · 1 min read
+
+by **[James - Lead Programmer](https://github.com/lolmansReturn)**
+
+---
+
+**Hi developers,**
+
+With framework update 7.0.0, we have been working on a upgraded networking system and a better API naming scheme.
+
+### New Networking System
+
+Here we bring you another new networking system once again, completely rethought from the ground up. What it is doing is this time it is separating events and functions, no longer making specific controllers. This makes more sense for newer users and also has some performance gains.
+
+### Rename Older API
+
+We renamed a fair bit of the older API to make more sense with the latest standards. This includes renaming `Signal` to `Event` to have parity with our networking system.
+
+### Docs Overhaul
+
+We completely overhauled the docs fixing any issues with grammar or using older API examples. We also fixed up the changelog by updating links and fixing wrong information.
+
+### New Automation Features
+
+New automation scripts have been added to the Git repository, featuring automatically created releases and automatically published wally packages. This is now standard with the rest of our packages as well!
+
+---
+
+If you're interested in contributing, please make a PR on our GitHub!
diff --git a/docs/recaps/index.md b/docs/recaps/index.md
@@ -1,29 +1,29 @@
-# Engine Recap - February 2024
-March 1, 2024 · 1 min read
+# Recap - April 2024
+April 28, 2024 · 1 min read
 
-by **[James - Lead Programmer](https://github.com/lolmansReturn)**
+by **[James - Lead Programmer](https://github.com/2jammers)**
 
 ---
 
 **Hi developers,**
 
-With framework update 7.0.0, we have been working on a upgraded networking system and a better API naming scheme.
+With update 8.0.0, you recieve a totally refreshed and rethought framework
 
-### New Networking System
+### Custom Networking System
 
-Here we bring you another new networking system once again, completely rethought from the ground up. What it is doing is this time it is separating events and functions, no longer making specific controllers. This makes more sense for newer users and also has some performance gains.
+Instead of relying on an external package, we have made our own custom networking system with similar performance gains. Some improvements include the addition of the `FireNow` API. This allows you to skip batching and not fire the next frame, and we also introduced batching for unreliable events. If the collected data is under 840 bytes by the time it is batched, you will see performance gains.
 
-### Rename Older API
+### Better Module Loading
 
-We renamed a fair bit of the older API to make more sense with the latest standards. This includes renaming `Signal` to `Event` to have parity with our networking system.
+We improved the module loader API, now allowing for a filter and a parent instance instead of a list. We highly encourage a single-script architecture in light of this change, and this makes it much easier.
 
-### Docs Overhaul
+### Better Documentation
 
-We completely overhauled the docs fixing any issues with grammar or using older API examples. We also fixed up the changelog by updating links and fixing wrong information.
+We have rewritten the tutorials in the documentation to include better wording and they are now much easier to follow along with. We also introduced more tutorials for each API area.
 
-### New Automation Features
+### Branding Changes
 
-New automation scripts have been added to the Git repository, featuring automatically created releases and automatically published wally packages. This is now standard with the rest of our packages as well!
+We changed the framework name from CanaryEngine to LuminFramework in light of the organization changing. We hope that it is much easier to distinguish the framework from a game engine now!
 
 ---
 

diff --git a/docs/recaps/july2023.md b/docs/recaps/july2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - July 2023
+# Recap - July 2023
 July 31, 2023 · 2 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/june2023.md b/docs/recaps/june2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - June 2023
+# Recap - June 2023
 June 28, 2023 · 2 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/november2023.md b/docs/recaps/november2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - November 2023
+# Recap - November 2023
 November 21, 2023 · 1 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/october2023.md b/docs/recaps/october2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - October 2023
+# Recap - October 2023
 October 27, 2023 · 1 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**

diff --git a/docs/recaps/september2023.md b/docs/recaps/september2023.md
@@ -1,4 +1,4 @@
-# Engine Recap - September 2023
+# Recap - September 2023
 September 23, 2023 · 1 min read
 
 by **[James - Lead Programmer](https://github.com/lolmansReturn)**