From fd8c8e245c4c0305da80af5b8f93c08dba987cca Mon Sep 17 00:00:00 2001 From: Fernando-A-Rocha Date: Sat, 18 Jan 2025 12:33:30 +0000 Subject: [PATCH] Add WIP wiki structure --- articles/.gitkeep | 0 articles/getting-started.md | 3 ++ articles/guides/introduction-to-scripting.md | 3 ++ articles/introduction.md | 7 ++++ navigation/structure.yaml | 33 ++++++++++++++++++ schemas/structure.yaml | 36 ++++++++++++++++++++ 6 files changed, 82 insertions(+) delete mode 100644 articles/.gitkeep create mode 100644 articles/getting-started.md create mode 100644 articles/guides/introduction-to-scripting.md create mode 100644 articles/introduction.md create mode 100644 navigation/structure.yaml create mode 100644 schemas/structure.yaml diff --git a/articles/.gitkeep b/articles/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/articles/getting-started.md b/articles/getting-started.md new file mode 100644 index 0000000..1bdbaf9 --- /dev/null +++ b/articles/getting-started.md @@ -0,0 +1,3 @@ +# Getting Started + +This is the first article in the series. It will help you get started with the project. diff --git a/articles/guides/introduction-to-scripting.md b/articles/guides/introduction-to-scripting.md new file mode 100644 index 0000000..a6752d7 --- /dev/null +++ b/articles/guides/introduction-to-scripting.md @@ -0,0 +1,3 @@ +# Introduction to Scripting + +Test diff --git a/articles/introduction.md b/articles/introduction.md new file mode 100644 index 0000000..f2d6b91 --- /dev/null +++ b/articles/introduction.md @@ -0,0 +1,7 @@ +# Introduction + +Welcome to the Multi Theft Auto: Wiki website. + +## This is the main page of the documentation + +Test 123 diff --git a/navigation/structure.yaml b/navigation/structure.yaml new file mode 100644 index 0000000..60af389 --- /dev/null +++ b/navigation/structure.yaml @@ -0,0 +1,33 @@ +wiki: + # Homepage + - title: "Introduction" + description: "Welcome to the MTA Wiki" + path: "/" + article: "introduction" + + # Guides Index + - title: "Getting Started" + description: "A guide to get you started with MTA" + path: "/getting-started" + article: "getting-started" + children: + - title: "Introduction to Scripting" + path: "/guides/introduction-to-scripting" + article: "guides/introduction-to-scripting" + + # Reference Index + - title: "Lua API Reference" + path: "/lua" + article: "lua" + children: + - title: "Client Functions" + path: "/lua/client-functions" + category: "Client functions" + + - title: "Server Functions" + path: "/lua/server-functions" + category: "Server functions" + + - title: "Shared Functions" + path: "/lua/shared-functions" + category: "Shared functions" diff --git a/schemas/structure.yaml b/schemas/structure.yaml new file mode 100644 index 0000000..3125149 --- /dev/null +++ b/schemas/structure.yaml @@ -0,0 +1,36 @@ +$schema: "https://json-schema.org/draft/2020-12/schema" +$id: "/schemas/structure" + +title: "Wiki Navigation Schema" +type: "array" +items: + $ref: "#/$defs/section" + +$defs: + section: + type: "object" + required: + - title + - path + properties: + title: + type: "string" + description: "The title of the section or article." + description: + type: "string" + description: "A brief description of the section or article." + path: + type: "string" + description: "The URL path for this section or article." + article: + type: "string" + description: "The file or identifier of the corresponding article." + pattern: "^[a-zA-Z0-9/_-]+$" + category: + type: "string" + description: "The category name for the section." + children: + type: "array" + description: "A list of subsections or subcategories." + items: + $ref: "#/$defs/section"