Skip to content

Commit 73e897b

Browse files
contributing update
1 parent a086559 commit 73e897b

File tree

1 file changed

+61
-3
lines changed

1 file changed

+61
-3
lines changed

CONTRIBUTING.md

Lines changed: 61 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,63 @@
1-
# Contributing
1+
# Contributing to wiki.multitheftauto.com
22

3-
Thank you for your interest in contributing to the Multi Theft Auto: Wiki. This guide will help you get started.
3+
Thanks for your interest in contributing to the MTA:SA Lua API documentation!
44

5-
TBA
5+
We are currently restructuring and modernizing how the API is documented in this repository. Please follow the priorities below when contributing.
6+
7+
## 📚 Philosophy & Objective
8+
9+
The goal of this new documentation system is to provide a clean, structured, and authoritative reference for the **MTA:SA Lua API and core engine features only**.
10+
11+
This repository is not intended to serve as a general-purpose wiki or community hub. It will only host official documentation related to:
12+
- Built-in Lua functions
13+
- Events
14+
- Elements and element types
15+
- Data structures and native MTA functionality
16+
17+
We are deliberately excluding community-created content, such as:
18+
- Third-party resources (e.g. DGS, scoreboard, etc.)
19+
- Tutorials, guides, or scripting best practices
20+
- Pages about servers, mods, or other fan-made projects
21+
22+
These kinds of content are valuable to the community, but they will be organized and maintained elsewhere, outside this repository, in a more suitable space (e.g. community wiki, forums, or Discord).
23+
24+
By keeping this documentation focused and consistent, we aim to create a high-quality, structured, and future-proof source of truth for all MTA:SA development.
25+
26+
## 🥇 Priority 1: Finish the Lua API Structure
27+
28+
Help us refine and complete the YAML schema definitions for all API types:
29+
- `functions/`
30+
- `events/`
31+
- `elements/`
32+
33+
The goal is to have a complete **YAML schema** for each API type (function, event, element), with all the necessary information (syntax, notes, return values, code examples, etc.), **ready for automatic generation of documentation pages**. Ensure that the YAML files are well-structured and follow the conventions used in the existing files.
34+
35+
## 🥈 Priority 2: Finish the Site UI and UX
36+
37+
Ensure the site properly renders:
38+
- Function pages
39+
- Event pages
40+
- Element pages
41+
- Code examples and cross-references
42+
- Additional articles
43+
44+
Report issues or inconsistencies in the frontend rendering or contribute layout/fix improvements via pull request.
45+
46+
You may also submit additional site improvements, such as a bookmarks system or other features that enhance user experience.
47+
48+
## 🥉 Later Phase: Port Legacy Wiki Content
49+
50+
Once the structure and display are complete, we’ll begin porting all legacy wiki documentation into YAML format.
51+
52+
This phase is not the current focus, but feel free to experiment or prepare tools/scripts to assist with this process.
53+
54+
## Getting Started
55+
56+
1. Fork the repository
57+
2. Clone your fork (creates a local copy)
58+
3. To work on a contribution, create a new branch for your changes (based on `main`)
59+
4. Make your changes and commit them with a clear message (e.g. `Fix code example display for function pages`)
60+
61+
## Keep in Touch
62+
63+
Join the [MTA Development Discord server](https://forum.multitheftauto.com/topic/133917-our-dedicated-mta-development-discord-server/) and ask for help in the #data-driven-docs channel. We are happy to assist you with any questions or issues you may have while contributing.

0 commit comments

Comments
 (0)