Skip to content

Commit

Permalink
WIP structure
Browse files Browse the repository at this point in the history
  • Loading branch information
Fernando-A-Rocha committed Jan 18, 2025
1 parent 3707478 commit a070f26
Show file tree
Hide file tree
Showing 15 changed files with 185 additions and 46 deletions.
Empty file.
3 changes: 0 additions & 3 deletions articles/getting-started.md

This file was deleted.

3 changes: 0 additions & 3 deletions articles/guides/introduction-to-scripting.md

This file was deleted.

7 changes: 0 additions & 7 deletions articles/introduction.md

This file was deleted.

3 changes: 3 additions & 0 deletions articles/introduction/article.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Welcome

Hi
5 changes: 5 additions & 0 deletions articles/introduction/article.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
content: "article.md"
author: "MTA Team"
date: "2025-01-01 12:00:00"
revisions: []
assets: []
3 changes: 3 additions & 0 deletions articles/lua-api-reference/article.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Lua API Reference

TODO: Introduce the MTA Lua API system.
5 changes: 5 additions & 0 deletions articles/lua-api-reference/article.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
content: "article.md"
author: "MTA Team"
date: "2025-01-01 12:00:00"
revisions: []
assets: []
3 changes: 3 additions & 0 deletions articles/official-guides/getting-started/article.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Getting Started

Test
5 changes: 5 additions & 0 deletions articles/official-guides/getting-started/article.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
content: "article.md"
author: "MTA Team"
date: "2025-01-01 12:00:00"
revisions: []
assets: []
33 changes: 0 additions & 33 deletions navigation/structure.yaml

This file was deleted.

45 changes: 45 additions & 0 deletions schemas/article.yaml
Original file line number Diff line number Diff line change
@@ -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."
27 changes: 27 additions & 0 deletions schemas/categories.yaml
Original file line number Diff line number Diff line change
@@ -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"
29 changes: 29 additions & 0 deletions wiki/categories.yaml
Original file line number Diff line number Diff line change
@@ -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"
60 changes: 60 additions & 0 deletions wiki/structure.yaml
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit a070f26

Please sign in to comment.