Add CONTRIBUTING.md

Author: Fernando-A-Rocha

CONTRIBUTING.md

@@ -0,0 +1,54 @@
+# Contributing
+
+Thank you for your interest in contributing to the Multi Theft Auto: Wiki. This guide will help you get started.
+
+## Getting Started
+
+1. **Fork the Repository**
+   - Click the "Fork" button at the top-right of this GitHub repository's page to create your own copy.
+
+2. **Clone the Repository**
+   - Clone your forked repository to your local machine ([tutorial](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository)).
+
+3. **Create a Branch**
+   - Before making any changes, create a new branch to keep your work organized ([tutorial](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository)).
+
+## Editing Wiki Pages
+
+The Wiki is generated by code, which relies on data present in this repository. Most text content uses the Markdown format. You can edit the files to make changes to the Wiki pages.
+
+1. Navigate to the folder that contains the page you want to edit.
+
+    - Articles are defined in the [articles](/articles) folder.
+    - Lua Functions are defined in the [functions](/functions) folder.
+    - Lua Events are defined in the [events](/events) folder.
+    - Lua Elements are defined in the [elements](/elements) folder.
+    - Additional asset files can be stored in the [assets](/assets) folder.
+
+2. Each folder may contain a `README.md` file with instructions or guidelines specific to the files in that directory. **Read these instructions carefully before making changes.**
+
+3. Make your edits to the relevant file(s) using your preferred text editor.
+
+## Testing Your Changes
+
+Follow the provided instructions in the [`web/README.md`](/web/README.md) file.
+
+## Submitting Your Changes
+
+1. Commit your changes with a clear and descriptive message, e.g. `Add new article on scripting events`.
+
+2. Push your branch to your forked repository.
+
+3. Open a Pull Request:
+   - Go to the original repository ([https://github.com/multitheftauto/mtasa-wiki](https://github.com/multitheftauto/mtasa-wiki)).
+   - Click "Pull Requests" and then "New Pull Request."
+   - Select your branch from your fork as the source and submit your pull request.
+
+## Guidelines
+
+- Follow the structure and formatting conventions used in the existing files.
+- Make sure your edits are clear, concise, and accurate.
+- Provide useful commit messages to explain your changes.
+- If you have questions or need clarification, open an issue or ask for help in your pull request.
+
+We appreciate your contributions to improving the Multi Theft Auto: Wiki!

web/resources/article.html

@@ -1,6 +1,14 @@
-{{ article.html_content }}
 
-<div style="text-align: left; font-size: 0.8em; color: #b5b5b5; position: absolute; bottom: 0; padding-bottom: 20px; max-width: 100%;">
-    <div>Article: <strong>{{ article.title }}</strong></div>
-    <div style="margin-top: 0.5em;">Written by <i class="fab fa-github"></i> <a href="https://github.com/{{ article.author }}" rel="noopener" target="_blank">{{ article.author }}</a> on {{ article.date }}</div>
+<div style="float: right; text-align: right; margin-bottom: 10px;">
+    <div style="color: #fff; font-size: 1em;">
+        Article: <strong>{{ article.title }}</strong>
+        <a style="margin-left: 2px;" href="https://github.com/multitheftauto/mtasa-wiki/tree/main/articles/{{article.path_repo}}" rel="noopener" target="_blank">
+            <i class="fa-solid fa-pen-to-square"></i>
+        </a>
+    </div>
+    <div style="color: #b5b5b5; font-size: 0.8em; margin-top: 0.5em;">
+        Written by <i class="fab fa-github"></i> <a href="https://github.com/{{ article.author }}" rel="noopener" target="_blank">{{ article.author }}</a> on {{ article.date }}
+    </div>
 </div>
+
+{{ article.html_content }}

web/resources/layout.html

@@ -100,8 +100,7 @@
     <footer>
         <div class="inner">
             <p>Copyright &copy; {{ year }} Multi Theft Auto team and contributors</p>
-            <p><i class="fab fa-github"></i> <a href="https://github.com/multitheftauto/mtasa-wiki" rel="noopener" target="_blank">Wiki on GitHub</a></p>
-            <p><a href="/privacy">Privacy policy</a></p>
+            <p><i class="fab fa-github"></i> <a href="https://github.com/multitheftauto/mtasa-wiki" rel="noopener" target="_blank">Wiki on GitHub</a> | <a href="/privacy">Privacy policy</a></p>
         </div>
     </footer>
 

web/scripts/builder.py

@@ -216,8 +216,8 @@ def create_function(self, function_name):
 
         return function
 
-    def create_article(self, article_name, article_parent_path='', custom_web_path=False):
-        article_real_path = os.path.join(DOCS_REPO_PATH, 'articles', article_parent_path, article_name, f"article.yaml")
+    def create_article(self, article_name, articles_folder='', custom_web_path=False):
+        article_real_path = os.path.join(DOCS_REPO_PATH, 'articles', articles_folder, article_name, f"article.yaml")
         article = utils.load_and_validate_yaml(article_real_path, self.schema_article)
 
         content_path = article.get('content')