Skip to content

Commit

Permalink
Add WIP wiki structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Fernando-A-Rocha committed Jan 18, 2025
1 parent 2ccc07a commit fd8c8e2
Show file tree
Hide file tree
Showing 6 changed files with 82 additions and 0 deletions.
Empty file removed articles/.gitkeep
Empty file.
3 changes: 3 additions & 0 deletions articles/getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started

This is the first article in the series. It will help you get started with the project.
3 changes: 3 additions & 0 deletions articles/guides/introduction-to-scripting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Introduction to Scripting

Test
7 changes: 7 additions & 0 deletions articles/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Introduction

Welcome to the Multi Theft Auto: Wiki website.

## This is the main page of the documentation

Test 123
33 changes: 33 additions & 0 deletions navigation/structure.yaml
Original file line number Diff line number Diff line change
@@ -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"
36 changes: 36 additions & 0 deletions schemas/structure.yaml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit fd8c8e2

Please sign in to comment.