rearrange

pyxfluff · Sep 5, 2024 · c4e20a5 · c4e20a5
1 parent 2569c6e
commit c4e20a5
Show file tree

Hide file tree

Showing 5 changed files with 111 additions and 70 deletions.
diff --git a/.vitepress/config.mts b/.vitepress/config.mts
@@ -25,7 +25,14 @@ export default defineConfig({
                 text: "Application API",
                 items: [
                     { text: "Quickstart", link: "/apps/quickstart" },
-                    { text: "Detailed API", link: "/apps/detailed" }
+                    {
+                        text: "Namespaces",
+                        items: [
+                            { text: "App", link: "/apps/namespace/app" },
+                            { text: "BuiltAPI", link: "/apps/namespace/builtapi" }
+                        ],
+                        collapsed: false
+                    }
                 ],
                 collapsed: false
             }

diff --git a/apps/namespace/app.md b/apps/namespace/app.md
@@ -0,0 +1,58 @@
+# App
+
+## `App.ActivateUI`
+
+::: warning
+This method is meant for internal use only. No support will be provided if you have issues with it.
+:::
+
+::: code-group
+
+```lua [Annotation]
+ActivateUI(UI: Frame): nil
+```
+
+```lua [Example]
+ActivateUI(script.Parent.NewUI)
+```
+
+:::
+
+Activates the specified Application UI, will create the `AdministerApps` folder if it doesn't exist already.
+
+
+## `App.Build`
+
+::: code-group
+
+```lua [Annotation]
+Build(OnBuild: Function, AppConfig: Table, AppButton: Table): nil
+```
+
+```lua [Example]
+Build(
+    function (AppConfig, BuiltAPI)
+        print(AppConfig, BuiltAPI)
+    end,
+    {},  -- For future release
+    {
+        Icon = "rbxassetid://0000",
+        Name = "An Application",
+        Frame = script.Parent.UI,
+        Tip = "This application does something.",
+        HasBG = true,
+        BGOverride = "rbxassetid://0000"
+    }
+)
+```
+
+:::
+
+Build the specified app using the given `AppConfig`, will run `OnBuild` after building as follows:
+```lua
+local function OnBuild(AppConfig, BuiltAPI)
+    -- AppConfig will be the same as you specified in `App.Build`
+end
+```
+
+For documentation about `BuiltAPI`, see [BuiltAPI](./builtapi.md).
diff --git a/apps/detailed.md → apps/namespace/builtapi.md b/apps/detailed.md → apps/namespace/builtapi.md
@@ -1,67 +1,6 @@
-# Detailed Application Documentation
+# BuiltAPI
 
-## App
-
-### `App.ActivateUI`
-
-::: warning
-This method is meant for internal use only. No support will be provided if you have issues with it.
-:::
-
-::: code-group
-
-```lua [Annotation]
-ActivateUI(UI: Frame): nil
-```
-
-```lua [Example]
-ActivateUI(script.Parent.NewUI)
-```
-
-:::
-
-Activates the specified Application UI, will create the `AdministerApps` folder if it doesn't exist already.
-
-
-### `App.Build`
-
-::: code-group
-
-```lua [Annotation]
-Build(OnBuild: Function, AppConfig: Table, AppButton: Table): nil
-```
-
-```lua [Example]
-Build(
-    function (AppConfig, BuiltAPI)
-        print(AppConfig, BuiltAPI)
-    end,
-    {},  -- For future release
-    {
-        Icon = "rbxassetid://0000",
-        Name = "An Application",
-        Frame = script.Parent.UI,
-        Tip = "This application does something.",
-        HasBG = true,
-        BGOverride = "rbxassetid://0000"
-    }
-)
-```
-
-:::
-
-Build the specified app using the given `AppConfig`, will run `OnBuild` after building as follows:
-```lua
-local function OnBuild(AppConfig, BuiltAPI)
-    -- AppConfig will be the same as you specified in `App.Build`
-end
-```
-
-For documentation about `BuiltAPI`, see [BuiltAPI](#builtapi).
-
-## BuiltAPI
-
-### `BuiltAPI.NewNotification`
+## `BuiltAPI.NewNotification`
 
 ::: warning
 This method is still under development.
@@ -112,13 +51,13 @@ NewNotification({
 Immediately displays a new notification (or multiple) with the given details.  
 If `OpenDuration` is not specified, the close button will be available immediately.  
 
-### `BuiltAPI.AppNotificationBlip`
+## `BuiltAPI.AppNotificationBlip`
 
 ::: warning
 This method is still under development.
 :::
 
-### `BuiltAPI.IsAdmin`
+## `BuiltAPI.IsAdmin`
 
 ::: code-group
 
@@ -143,7 +82,7 @@ If you provide a non-admin only group, anyone in it will have full admin access!
 :::
 
 
-### `BuiltAPI.NewRemoteEvent`
+## `BuiltAPI.NewRemoteEvent`
 
 ::: code-group
 
@@ -168,7 +107,7 @@ If an event with the given name already exists, the existing event will be retur
 If the provided `OnServerEvent` is not a function, it will be ignored.  
 Any additional arguments will be passed along to the internal `:Connect` call.
 
-### `BuiltAPI.NewRemoteFunction`
+## `BuiltAPI.NewRemoteFunction`
 
 ::: code-group
 

diff --git a/apps/quickstart.md b/apps/quickstart.md
@@ -4,7 +4,7 @@ Creating an Administer app is about as easy as it can get.
 
 <div class = "tip custom-block" style = "padding-top: 8px">
 
-Need the full documentation? Skip to the [Detailed Documentation](./detailed.md).
+Need the full documentation? Skip to the [Detailed Documentation](./namespace/app.md).
 
 </div>
 
@@ -39,7 +39,7 @@ local AppConfig = {
 }
 ```
 
-Afterwards, you should [build your application](./detailed.md#app-build) like so:
+Afterwards, you should [build your application](./namespace/app.md#app-build) like so:
 ```lua
 App.Build(
     function (config, built)

diff --git a/what-is-administer.md b/what-is-administer.md
@@ -0,0 +1,37 @@
+# What is Administer?
+
+## What is it?
+
+Administer is an admin system which takes modularity to a level never seen before. You only keep what you need. Don't need announcements? Get rid of it.
+We also have a modern and consistient admin panel which does everything you'll ever need.
+
+## Installation
+
+::: danger
+Administer will NOT boot without access to Studio APIs and HTTPService!  
+**Do NOT report any bugs if you see errors related to API access denied.**
+:::
+
+Administer is ready to go out of the box. Just install it from the Creator Store and place the script in [ServerScriptStorage](https://create.roblox.com/docs/reference/engine/classes/ServerScriptService).
+After that, you'll instantly be ready to go and add apps to your heart's content.
+
+The game's owner account/group will automatically be added as an admin.  
+You can configure additional admins in the Admins script or in the panel **(recommended)**.
+
+## Contributions
+
+Contributions are more than welcome (i'm just one person!) and will be reviewed shortly. We use Rojo so it's an easy sync (given you have the proper setup).
+
+Feeling nice? Add a feature from [our development priorities](https://trello.com/b/GA5Kc0vB/administer). Want to fix a bug? Just push the fix. 
+
+If you're adding a new feature, you may want to open an issue before coding something. We may deny PRs if it does not contribute to the project in a way an app can't. If you want an app on the main app server please [reach out to me](https://discord.com/users/449950252397494274).
+
+## Credits
+
+Administer is mostly developed with :heart: by [@pyxfluff](https://github.com/pyxfluff). Some apps are by other Administer team members. We also use multiple OSS resources, such as:
+
+- UICons: FlatIcon
+- QuickBlur: [@pixe_ated](https://devforum.roblox.com/u/pixe_ated)
+- MUI Button Animations: [@Qinrir](https://devforum.roblox.com/u/Qinrir)
+- neon: [@fractality](https://devforum.roblox.com/u/fractality)
+- Server finder base logic: [@kylerzong](https://devforum.roblox.com/u/kylerzong)