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 @@ + + + + +
+ Paradox AntiCheat Logo +
+ +

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

+
    +
  1. Fork the repository: Click on the "Fork" button on the Paradox_AntiCheat GitHub page.
  2. +
  3. Clone the repository: Clone your fork to your local machine: +
    git clone https://github.com/<your-github-username>/Paradox_AntiCheat.git
    +
  4. +
  5. Navigate to the Paradox_AntiCheat (root) directory: +
    cd Paradox_AntiCheat
    +
  6. +
+ +

Setting Up the Development Environment

+
    +
  1. Install Dependencies: In the Paradox_AntiCheat (root) directory, run the following command to install the necessary dependencies: +
    npm i
    +
  2. +
+ +

Testing the Docs Locally with Docsify

+

Docsify is used to generate the documentation site. To test changes locally:

+
    +
  1. 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. +
  2. +
  3. Make Changes: Edit the Markdown files in the /docs directory. You can add new content, update existing sections, or fix formatting issues.
  4. +
  5. 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.
  6. +
  7. 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.
  8. +
+ +

Submitting Changes

+
    +
  1. Commit Your Changes: Once you’re happy with your changes, commit them: +
    git add .
    +
    git commit -m "Description of the changes"
    +
  2. +
  3. Push Your Changes: Push your changes to your forked repository: +
    git push origin <branch-name>
    +
  4. +
  5. 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.
  6. +
+ +

Additional Notes

+ + +

Thank you for contributing to Paradox AntiCheat documentation!

+ + +