From 5e195b0d9dfde28f9cafc8fd5500674b5140b369 Mon Sep 17 00:00:00 2001
From: Visual1mpact <97915078+Visual1mpact@users.noreply.github.com>
Date: Wed, 20 Nov 2024 19:36:22 -0500
Subject: [PATCH] [Docs] Create new README.md
Add contributing guidelines and local testing instructions for /docs
- Added detailed instructions for contributing to the Paradox AntiCheat documentation.
- Included steps for setting up the development environment and testing docs locally with Docsify.
---
docs/README.md | 72 ++++++++++++++++++++++++++++++++++++++++++++++++++
1 file changed, 72 insertions(+)
create mode 100644 docs/README.md
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 00000000..80da7f7b
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,72 @@
+
+
+
+
+
+
+
Contributing to the Paradox AntiCheat Documentation
+
+ Welcome to the Paradox AntiCheat documentation repository! This guide will help you contribute to the website, make changes, and test them locally before submitting a pull request.
+
+ Prerequisites
+ Before contributing to the documentation, make sure you have the following installed:
+
+
+ Cloning the Repository
+
+ - Fork the repository: Click on the "Fork" button on the Paradox_AntiCheat GitHub page.
+ - Clone the repository: Clone your fork to your local machine:
+
git clone https://github.com/<your-github-username>/Paradox_AntiCheat.git
+
+ - Navigate to the Paradox_AntiCheat (root) directory:
+
cd Paradox_AntiCheat
+
+
+
+ Setting Up the Development Environment
+
+ - Install Dependencies: In the Paradox_AntiCheat (root) directory, run the following command to install the necessary dependencies:
+
npm i
+
+
+
+ Testing the Docs Locally with Docsify
+ Docsify is used to generate the documentation site. To test changes locally:
+
+ - Start the Local Server: Run the following command at the root of Paradox_AntiCheat to start a local server:
+
node server.js
+ This will start a local development server, and you can preview the documentation at http://localhost:4000 unless otherwise specified.
+
+ - Make Changes: Edit the Markdown files in the /docs directory. You can add new content, update existing sections, or fix formatting issues.
+ - Preview Your Changes: As you make changes, the local Docsify server will automatically reload the page to show your updates after you refresh the page.
+ - Gracefully Stop the Server: Once you're done testing locally, you can stop the server gracefully by pressing `Ctrl + C` in the terminal where the server is running. This will terminate the server process.
+
+
+ Submitting Changes
+
+ - Commit Your Changes: Once you’re happy with your changes, commit them:
+
git add .
+ git commit -m "Description of the changes"
+
+ - Push Your Changes: Push your changes to your forked repository:
+
git push origin <branch-name>
+
+ - Create a Pull Request: Go to the original Paradox_AntiCheat GitHub repository and create a pull request with your changes. Be sure to include a clear description of what changes you’ve made.
+
+
+ Additional Notes
+
+ - Markdown Formatting: Ensure that your Markdown files are well formatted. You can use tools like Markdownlint for checking formatting.
+ - Docsify Features: Refer to the Docsify documentation for more details on customizing the documentation site.
+
+
+ Thank you for contributing to Paradox AntiCheat documentation!
+
+
+