From cdf1c7cbdad118cb538a1d1a7c1bf5f3364edf72 Mon Sep 17 00:00:00 2001 From: Fernando-A-Rocha Date: Sat, 18 Jan 2025 15:19:25 +0000 Subject: [PATCH] . --- articles/introduction/article.yaml | 1 + articles/lua-api-reference/article.yaml | 1 + .../getting-started/article.yaml | 1 + schemas/article.yaml | 4 ++ schemas/categories.yaml | 17 +++++-- schemas/structure.yaml | 13 ++--- wiki/categories.yaml | 48 ++++++++++--------- wiki/structure.yaml | 42 +--------------- 8 files changed, 52 insertions(+), 75 deletions(-) diff --git a/articles/introduction/article.yaml b/articles/introduction/article.yaml index 3e32f8d..4f71bd9 100644 --- a/articles/introduction/article.yaml +++ b/articles/introduction/article.yaml @@ -1,3 +1,4 @@ +title: "Introduction" content: "article.md" author: "MTA Team" date: "2025-01-01 12:00:00" diff --git a/articles/lua-api-reference/article.yaml b/articles/lua-api-reference/article.yaml index 3e32f8d..228ed91 100644 --- a/articles/lua-api-reference/article.yaml +++ b/articles/lua-api-reference/article.yaml @@ -1,3 +1,4 @@ +title: "Lua API Reference" content: "article.md" author: "MTA Team" date: "2025-01-01 12:00:00" diff --git a/articles/official-guides/getting-started/article.yaml b/articles/official-guides/getting-started/article.yaml index 3e32f8d..310d089 100644 --- a/articles/official-guides/getting-started/article.yaml +++ b/articles/official-guides/getting-started/article.yaml @@ -1,3 +1,4 @@ +title: "Getting Started" content: "article.md" author: "MTA Team" date: "2025-01-01 12:00:00" diff --git a/schemas/article.yaml b/schemas/article.yaml index 42d6c09..264ae62 100644 --- a/schemas/article.yaml +++ b/schemas/article.yaml @@ -3,12 +3,16 @@ $id: "/schemas/structure" title: "Wiki Article Schema" type: "object" required: + - title - content - author - date - revisions - assets properties: + title: + type: "string" + description: "The title of the article." content: type: "string" description: "The file path for the article content." diff --git a/schemas/categories.yaml b/schemas/categories.yaml index b86586d..3bd4eb2 100644 --- a/schemas/categories.yaml +++ b/schemas/categories.yaml @@ -15,11 +15,20 @@ $defs: type: "string" description: "The name identifier of the category." articles: - type: "string" - description: "The identifier of the corresponding articles group." + type: "object" + properties: + path: + type: "string" + description: "The path to the articles." functions: - type: "string" - description: "The identifier of the corresponding functions group." + type: "object" + properties: + path: + type: "string" + description: "The path to the functions." + type: + type: "string" + description: "The type of functions to include (client/server/shared)." subcategories: type: "array" description: "A list of subsections or subcategories." diff --git a/schemas/structure.yaml b/schemas/structure.yaml index 375227b..0ec284c 100644 --- a/schemas/structure.yaml +++ b/schemas/structure.yaml @@ -18,22 +18,19 @@ $defs: properties: title: type: "string" - description: "The title of the section or article." - description: - type: "string" - description: "A brief description of the section or article." + description: "The title of the section." path: type: "string" - description: "The URL path for this section or article." + description: "The URL path for this section." article: type: "string" - description: "The file or identifier of the corresponding article." + description: "The name of the article." pattern: "^[a-zA-Z0-9/_-]+$" category: type: "string" - description: "The category name for the section." + description: "The name of the category." children: type: "array" - description: "A list of subsections or subcategories." + description: "A list of subsections." items: $ref: "#/$defs/section" diff --git a/wiki/categories.yaml b/wiki/categories.yaml index d6c6325..43316d3 100644 --- a/wiki/categories.yaml +++ b/wiki/categories.yaml @@ -1,29 +1,31 @@ - name: "Official guides" - articles: "official-guides" + articles: + path: "official-guides" - name: "Community guides" - articles: "community-guides" + articles: + path: "community-guides" -# - name: "Server functions" - -- name: "Client functions" +- name: "Lua reference" subcategories: - - name: "Cursor functions" - functions: - path: "Cursor" - type: "client" - - name: "Element functions" - functions: - path: "Element" - type: "client" + - 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" + - 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 index b8603c9..4bdd70b 100644 --- a/wiki/structure.yaml +++ b/wiki/structure.yaml @@ -1,14 +1,12 @@ wiki: # Homepage - path: "/" - title: "Introduction" - description: "Welcome to the MTA Wiki" + title: "Multi Theft Auto: Wiki" article: "introduction" # Guides Index - path: "/guides" title: "Guides" - description: "Guides and tutorials for MTA" children: - path: "/guides/official" title: "Official Guides" @@ -21,40 +19,4 @@ wiki: # 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" + category: "Lua reference"