WIP structure

Fernando-A-Rocha · Fernando-A-Rocha · commit a070f2652f3a · 2025-01-18T15:19:12.000Z
diff --git a/articles/community-guides/.gitkeep b/articles/community-guides/.gitkeep
diff --git a/articles/getting-started.md b/articles/getting-started.md
diff --git a/articles/guides/introduction-to-scripting.md b/articles/guides/introduction-to-scripting.md
diff --git a/articles/introduction.md b/articles/introduction.md
diff --git a/articles/introduction/article.md b/articles/introduction/article.md
@@ -0,0 +1,3 @@
+# Welcome
+
+Hi
diff --git a/articles/introduction/article.yaml b/articles/introduction/article.yaml
@@ -0,0 +1,5 @@
+content: "article.md"
+author: "MTA Team"
+date: "2025-01-01 12:00:00"
+revisions: []
+assets: []
diff --git a/articles/lua-api-reference/article.md b/articles/lua-api-reference/article.md
@@ -0,0 +1,3 @@
+# Lua API Reference
+
+TODO: Introduce the MTA Lua API system.
diff --git a/articles/lua-api-reference/article.yaml b/articles/lua-api-reference/article.yaml
@@ -0,0 +1,5 @@
+content: "article.md"
+author: "MTA Team"
+date: "2025-01-01 12:00:00"
+revisions: []
+assets: []
diff --git a/articles/official-guides/getting-started/article.md b/articles/official-guides/getting-started/article.md
@@ -0,0 +1,3 @@
+# Getting Started
+
+Test
diff --git a/articles/official-guides/getting-started/article.yaml b/articles/official-guides/getting-started/article.yaml
@@ -0,0 +1,5 @@
+content: "article.md"
+author: "MTA Team"
+date: "2025-01-01 12:00:00"
+revisions: []
+assets: []
diff --git a/navigation/structure.yaml b/navigation/structure.yaml
diff --git a/schemas/article.yaml b/schemas/article.yaml
@@ -0,0 +1,45 @@
+$schema: "https://json-schema.org/draft/2020-12/schema"
+$id: "/schemas/structure"
+title: "Wiki Article Schema"
+type: "object"
+required:
+  - content
+  - author
+  - date
+  - revisions
+  - assets
+properties:
+  content:
+    type: "string"
+    description: "The file path for the article content."
+  author:
+    type: "string"
+    description: "The author of the article."
+  date:
+    type: "string"
+    description: "The date the article was published."
+  revisions:
+    type: "array"
+    description: "A list of revisions made to the article."
+    items:
+      type: "object"
+      required:
+        - date
+        - author
+        - changes
+      properties:
+        date:
+          type: "string"
+          description: "The date the revision was made."
+        author:
+          type: "string"
+          description: "The author of the revision."
+        changes:
+          type: "string"
+          description: "A brief description of the changes made."
+  assets:
+    type: "array"
+    description: "A list of assets used in the article."
+    items:
+      type: "string"
+      description: "The file path for the asset."
diff --git a/schemas/categories.yaml b/schemas/categories.yaml
@@ -0,0 +1,27 @@
+$schema: "https://json-schema.org/draft/2020-12/schema"
+$id: "/schemas/categories"
+title: "Wiki Categories Schema"
+type: "array"
+items:
+  $ref: "#/$defs/section"
+
+$defs:
+  section:
+    type: "object"
+    required:
+      - name
+    properties:
+      name:
+        type: "string"
+        description: "The name identifier of the category."
+      articles:
+        type: "string"
+        description: "The identifier of the corresponding articles group."
+      functions:
+        type: "string"
+        description: "The identifier of the corresponding functions group."
+      subcategories:
+        type: "array"
+        description: "A list of subsections or subcategories."
+        items:
+          $ref: "#/$defs/item"
diff --git a/wiki/categories.yaml b/wiki/categories.yaml
@@ -0,0 +1,29 @@
+- name: "Official guides"
+  articles: "official-guides"
+
+- name: "Community guides"
+  articles: "community-guides"
+
+# - name: "Server functions"
+
+- name: "Client functions"
+  subcategories:
+    - name: "Cursor functions"
+      functions:
+        path: "Cursor"
+        type: "client"
+    - name: "Element functions"
+      functions:
+        path: "Element"
+        type: "client"
+
+- name: "Shared functions"
+  subcategories:
+    - name: "Cursor functions"
+      functions:
+        path: "Cursor"
+        type: "shared"
+    - name: "Element functions"
+      functions:
+        path: "Element"
+        type: "shared"
diff --git a/wiki/structure.yaml b/wiki/structure.yaml
@@ -0,0 +1,60 @@
+wiki:
+  # Homepage
+  - path: "/"
+    title: "Introduction"
+    description: "Welcome to the MTA Wiki"
+    article: "introduction"
+
+  # Guides Index
+  - path: "/guides"
+    title: "Guides"
+    description: "Guides and tutorials for MTA"
+    children:
+      - path: "/guides/official"
+        title: "Official Guides"
+        category: "Official guides"
+
+      - path: "/guides/community"
+        title: "Community Guides"
+        category: "Community guides"
+
+  # Reference Index
+  - title: "Lua API Reference"
+    path: "/lua"
+    article: "lua-api-reference"
+    children:
+      - path: "/lua/client-functions"
+        title: "Client Functions"
+        category: "Client functions"
+
+      - path: "/lua/client-events"
+        title: "Client Events"
+        category: "Client events"
+
+      - path: "/lua/server-functions"
+        title: "Server Functions"
+        category: "Server functions"
+
+      - path: "/lua/server-events"
+        title: "Server Events"
+        category: "Server events"
+
+      - path: "/lua/shared-functions"
+        title: "Shared Functions"
+        category: "Shared functions"
+
+      - path: "/lua/useful-functions"
+        title: "Useful Functions"
+        category: "Useful functions"
+
+      - path: "/lua/mta-classes"
+        title: "MTA Classes"
+        category: "MTA Classes"
+
+      - path: "/lua/mta-elements"
+        title: "MTA Elements"
+        category: "MTA Elements"
+
+      - path: "/lua/element-tree"
+        title: "Element Tree"
+        category: "Element Tree"

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# Lua API Reference`
	`2`	`+`
	`3`	`+TODO: Introduce the MTA Lua API system.`