docs: add roblox page

lukadev-0 · Feb 11, 2024 · e9a49f5 · e9a49f5
1 parent 945e7b5
commit e9a49f5
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 0 deletions.
diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -16,6 +16,7 @@ export default defineConfig({
         items: [
           { text: "Introduction", link: "/introduction" },
           { text: "Runtimes", link: "/runtimes" },
+          { text: "Roblox", link: "/roblox" },
         ],
       },
       {

diff --git a/docs/roblox.md b/docs/roblox.md
@@ -0,0 +1,11 @@
+# Roblox
+
+luau.util is designed to work on Roblox too, this is done by processing the
+code with [darklua](https://darklua.com/) which will convert the path requires
+into Roblox style requires.
+
+## Wally
+
+When syncing the code using [Rojo](https://rojo.space/), it will correctly use
+the Roblox version of the code, this is done by adding a `default.project.json`
+to the package and pointing it to the generated `roblox` directory.