First Public look into the potentially final interface

Author: TovarischPootis

.github/workflows/doc.yml

@@ -0,0 +1,10 @@
+name: LDoc
+on: [ push, pull_request ]
+jobs:
+  sile:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Generate docs with LDoc
+        uses: lunarmodules/ldoc@latest

.vscode/settings.json

@@ -0,0 +1,5 @@
+{
+    "Lua.diagnostics.globals": [
+        "tparam_alias"
+    ]
+}

config.ld

@@ -0,0 +1,50 @@
+---@diagnostic disable: undefined-global, lowercase-global
+project = 'LDoc NS'
+title = 'NS LDoc documentation'
+description = 'List of Constructs'
+format = 'markdown'
+dir = 'docs/developer'
+output = 'index'
+file = {
+    'D:/SteamLibrary/steamapps/common/GarrysMod/garrysmod/gamemodes/nutscript/docs/',
+    'D:/SteamLibrary/steamapps/common/GarrysMod/garrysmod/gamemodes/nutscript/gamemode/',
+    'D:/SteamLibrary/steamapps/common/GarrysMod/garrysmod/gamemodes/nutscript/plugins/',
+    exclude = {'D:/SteamLibrary/steamapps/common/GarrysMod/garrysmod/gamemodes/nutscript/gamemode/core/libs/thirdparty', 'D:/SteamLibrary/steamapps/common/GarrysMod/garrysmod/gamemodes/nutscript/plugins/_disabled/'}
+}
+
+ext = 'md'
+template = true
+multimodule = true
+merge = true
+simple_arg_list = true
+custom_tags = {
+    {
+        'realm',
+        hidden = true
+    },
+    {
+        'internal',
+        hidden = true
+    },
+    {
+        'pluginwarning',
+        hidden = true
+    }
+}
+
+tparam_alias('client', 'Client')
+tparam_alias('character', 'Character')
+tparam_alias('vector', 'Vector')
+tparam_alias('angle', 'Angle')
+tparam_alias('entity', 'Entity')
+
+kind_names = {
+    topic = 'Manual',
+    module = 'Libraries'
+}
+
+new_type("client", "Client", true)
+new_type("plugin", "Plugins", true)
+new_type("hook", "Hooks", true)
+new_type("derma", "Derma", true)
+new_type("metaclass", "Class", true)

docs/.pages renamed to docs/.nav.yml

@@ -1,5 +1,5 @@
-arrange:
+nav:
   - index.md
-  - guides
   - developer
-  - ...
+  - guides
+  - "*"

docs/assets/client.svg

@@ -0,0 +1,6 @@
+nav:
+  - index.md
+  - libraries
+  - classes
+  - hooks
+  - plugins