Update docs, and improve docs for retryer and race

docs/character.md

@@ -0,0 +1,4 @@
+# Character
+
+> [!INFO]
+> The docs for this library are incomplete

docs/grouper.md

@@ -1,8 +1,10 @@
-### Grouper
+# Grouper
 
 A module for getting accurate group ranks for players on the server, and detecting rank changes
 
-#### example
+> [!WARNING]
+> The docs for this library are outdated, but are mostly correct
+
 ```luau
 local text_chat_service = game:GetService("TextChatService")
 local players = game:GetService("Players")
@@ -23,7 +25,7 @@ local group_channels = {
 	[4] = create_text_channel("barista"),
 }
 
-grouper.init({
+grouper.init.server({
 	-- how often in seconds grouper should check to see if a players rank has changed
 	rank_refresh_rate = 60,
 	-- the groupid for the group grouper checks ranks for

docs/index.md

@@ -26,7 +26,7 @@ features:
     link: /linked-list
   - icon: 📊
     title: Log Analytics
-    details: a wrapper around roblox's AnalyticsService with a better api
+    details: A wrapper around roblox's AnalyticsService with a better api
     link: /log-analytics
   - icon: 👁️
     title: Observer
@@ -50,11 +50,11 @@ features:
     link: /ratelimit
   - icon: 🖼️
     title: RbxThumb
-    details: a utility for making roblox thumbnail urls
+    details: A utility for making roblox thumbnail urls
     link: /rbx-thumb
   - icon: 🔁
     title: Retryer
-    details: a simple utility for easily retrying functions
+    details: A simple utility for easily retrying functions
     link: /retryer
   - icon: 🛸
     title: Safe Teleport

docs/is-empty.md

@@ -0,0 +1,3 @@
+# Linked List
+
+A doubly-linked list implementation in luau

docs/leventine.md

@@ -0,0 +1,3 @@
+# Linked List
+
+A doubly-linked list implementation in luau

docs/linked-list.md

@@ -0,0 +1,3 @@
+# Linked List
+
+A doubly-linked list implementation in luau

docs/log-analytics.md

@@ -0,0 +1,4 @@
+# Log Analytics
+
+> [!INFO]
+> The docs for this library are incomplete

docs/player-zone.md

@@ -0,0 +1,4 @@
+# Player Zone
+
+> [!INFO]
+> The docs for this library are incomplete

docs/race.md

@@ -1,9 +1,7 @@
-### Race
+# Race
 
-utility function for getting the return from the first function
-in an array to return
+Runs several functions at once, and returns the result of the function that completes first
 
-#### example
 ```luau
 local task = require("@lune/task")
 local race = require("race")
@@ -20,5 +18,4 @@ local result = race({
 })
 
 print(result) -- "i return!"
-
 ```

docs/random.md

@@ -0,0 +1,6 @@
+# Random
+
+A implementation of robloxs random class in pure luau
+
+> [!INFO]
+> The docs for this library are incomplete

docs/ratelimit.md

@@ -0,0 +1,4 @@
+# Ratelimit
+
+> [!INFO]
+> The docs for this library are incomplete

docs/rbx-thumb.md

@@ -0,0 +1,4 @@
+
+
+> [!INFO]
+> The docs for this library are incomplete

docs/retryer.md

@@ -1,27 +1,68 @@
-### Retryer
+# Retryer
 
-Module for easily retrying functions
+A utility for easily retrying functions
 
-#### example
 ```luau
 local StarterGui = game:GetService("StarterGui")
 local retryer = require("retryer")
 
-local SET_CORE = StarterGui.SetCore
+retryer.inf(10, StarterGui.SetCore, "ResetButtonCallback", false)
 
-local function foo(n: number)
-    return n + 1
-end
+```
 
--- delay between retrys, max retrys, function to retry, function args
-local success, added = retryer.delay(10, 20, foo, 1)
+## Methods
+
+### `__call`
+
+Retrys a function x times, based on how many retries its allowed to make
 
+```luau
 -- max retrys, function to retry, function args
-local success, other_added = retryer(20, foo, 1)
+local success, added = retryer(20, function(n: number)
+    return n + 3
+end, 1)
+
+other_added -= 3
+```
+
+### `delay`
+
+Retrys a function x times, based on how many retries its allowed to make.
+With a delay in between thats provided as the first argument
+
+```luau
+-- delay between retrys, max retrys, function to retry, function args
+local success, added = retryer.delay(20, 10, function(n: number)
+    return n + 3
+end, 1)
+
 other_added -= 3
+```
+
+> [!DANGER]
+> The infinite methods can infinitely yield so its reccomened to not use them unless you have to
+> such as with [`StarterGui:SetCore()`](https://create.roblox.com/docs/reference/engine/classes/StarterGui#SetCore)
+
+### `inf`
+
+Works like [`__call`](#call), except that it infinitely retries until it succeeds
+
+```luau
+-- function to retry, function args
+local added = retryer(function(n: number)
+    return n + 3
+end, 1)
+
+other_added -= 3
+```
 
--- infretry is useful for stuff like StarterGui:SetCore()
--- where it will fail for a bit unless ur script is parented to StarterGui
-retryer.infretry(SET_CORE, "ResetButtonCallback", false)
+### `infdelay`
 
+Works like [`delay`](#delay), except that it infinitely retries until it succeeds
+
+```luau
+local StarterGui = game:GetService("StarterGui")
+
+retryer.infdelay(10, StarterGui.SetCore, "ResetButtonCallback", false)
 ```
+

docs/safe-teleport.md

@@ -0,0 +1,6 @@
+# Safe Teleport
+
+A teleport async wrapper that makes teleporting simple
+
+> [!INFO]
+> The docs for this library are incomplete

docs/text-chat.md

@@ -1 +1,4 @@
-lol
+# Text Chat
+
+> [!INFO]
+> The docs for this library are incomplete

docs/url.md

@@ -1 +1,4 @@
-lol
+# Url
+
+> [!INFO]
+> The docs for this library are incomplete