Update structure and style of docs, and added issue templates

Author: SystemXFiles

.github/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,29 @@
+---
+name: "Bug report"
+about: Create a bug report
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+## Describe the bug
+
+A clear and concise description of what the bug is.
+
+### Steps to reproduce
+
+Steps to reproduce the behavior.
+
+### Expected behavior
+
+A clear and concise description of what you expected to happen.
+
+### Environment
+
+- Windows Version: [e.g. 7/8/10/11]
+- Other details that you think may affect.
+
+### Additional context
+
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,20 @@
+---
+name: "Feature request"
+about: Suggest an idea
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+## Summary
+
+Brief explanation of the feature.
+
+### Basic example
+
+Include a basic example or links here.
+
+### Motivation
+
+Why are we doing this? What use cases does it support? What is the expected outcome?

docs/README.md

@@ -1,9 +1,50 @@
-![Logo Process Governor](images/headers/github-banner-readme.png)
+<a id="document-top"></a>
 
----
+[![Contributors][contributors-shield]][contributors-url]
+[![Forks][forks-shield]][forks-url]
+[![Stargazers][stars-shield]][stars-url]
+[![Issues][issues-shield]][issues-url]
+[![License][license-shield]][license-url]
 
-**Process Governor** is a Python utility designed to manage Windows processes and services by adjusting their
-priorities, I/O priorities, and core affinity based on user-defined rules.
+<br />
+<div align="center">
+  <a href="https://github.com/SystemXFiles/process-governor">
+    <img src="icons/logo.png" alt="Logo">
+  </a>
+
+<h3 align="center">Process Governor</h3>
+
+  <p align="center">
+    A utility to automate Windows process and service management.
+    <br />
+    <a href="#documentation"><strong>Explore the docs »</strong></a>
+    <br />
+    <br />
+    <a href="https://github.com/SystemXFiles/process-governor/issues/new?labels=bug&template=bug-report.md">Report Bug</a>
+    ·
+    <a href="https://github.com/SystemXFiles/process-governor/issues/new?labels=enhancement&template=feature-request.md">Request Feature</a>
+  </p>
+</div>
+
+<details>
+  <summary>Table of Contents</summary>
+  <ol>
+    <li><a href="#about-the-project">About The Project</a></li>
+    <li><a href="#getting-started">Getting Started</a></li>
+    <li><a href="#documentation">Documentation</a></li>
+    <li><a href="#star-history">Star History</a></li>
+    <li><a href="#license">License</a></li>
+  </ol>
+</details>
+
+## About The Project
+
+<div align="center">
+   <img src="images/screenshots/process_list_faded.png" width="95%" height="95%">
+</div>
+
+**Process Governor** is a Python utility that automates the management of Windows processes and services by adjusting
+their priorities, I/O priorities, and core affinity according to user-defined rules.
 
 ### Features
 
@@ -17,35 +58,68 @@ priorities, I/O priorities, and core affinity based on user-defined rules.
 <details>
     <summary>Click to expand</summary>
 
-> ![process_list.png](images/screenshots/process_list.png)
+> ![](images/screenshots/process_list.png)
 >
-> ![process_rules.png](images/screenshots/process_rules.png)
+> ![](images/screenshots/process_rules.png)
 >
-> ![tray_menu.png](images/screenshots/tray_menu.png)
+> ![](images/screenshots/tray_menu.png)
 </details>
 
-## Getting started
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
+## Getting Started
 
 To get started with **Process Governor**, follow these steps:
 
 1. Download the latest ready-to-use build from the following
    link: [Latest Release](https://github.com/SystemXFiles/process-governor/releases/latest).
 2. Run the `Process Governor.exe` executable with **administrative privileges**.
-   This is important to allow the program to make the necessary adjustments to process and service priorities, I/O
-   priorities, and core affinity.
 3. Configure the rules for processes and services.
-4. **Optionally**, you can enable auto-start for the program to launch automatically with
-   the system.
+4. **Optionally**, enable auto-start for the program to launch automatically with the system.
 
 You can close the program by accessing the tray icon.
 
-## Knowledge base
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
+## Documentation
 
 - [Process Governor UI](ui_process_governor.md)
 - [Rule Behavior and Tips](rule_behavior_and_tips.md)
 - [Configuration file](configuration_file.md)
 - [Running from source and creating a portable build](run_and_build.md)
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
+## Star History
+
+[![Star History Chart](https://api.star-history.com/svg?repos=SystemXFiles/process-governor&type=Date)](https://star-history.com/#SystemXFiles/process-governor&Date)
+
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## License
 
-This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](../LICENSE) file for details.
+This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](../LICENSE) file for details.
+
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
+<!-- MARKDOWN LINKS & IMAGES -->
+
+[contributors-shield]: https://img.shields.io/github/contributors/SystemXFiles/process-governor.svg?style=for-the-badge
+
+[contributors-url]: https://github.com/SystemXFiles/process-governor/graphs/contributors
+
+[forks-shield]: https://img.shields.io/github/forks/SystemXFiles/process-governor.svg?style=for-the-badge
+
+[forks-url]: https://github.com/SystemXFiles/process-governor/network/members
+
+[stars-shield]: https://img.shields.io/github/stars/SystemXFiles/process-governor.svg?style=for-the-badge
+
+[stars-url]: https://github.com/SystemXFiles/process-governor/stargazers
+
+[issues-shield]: https://img.shields.io/github/issues/SystemXFiles/process-governor.svg?style=for-the-badge
+
+[issues-url]: https://github.com/SystemXFiles/process-governor/issues
+
+[license-shield]: https://img.shields.io/github/license/SystemXFiles/process-governor.svg?style=for-the-badge
+
+[license-url]: https://github.com/SystemXFiles/process-governor/blob/master/LICENSE

docs/configuration_file.md

@@ -1,16 +1,15 @@
-# Configuration File
+<a id="document-top"></a>
 
-[![README](icons/readme.png) README](README.md)
+# Configuration File
 
----
+[![README](icons/readme.png) README](README.md#documentation)
 
 The `config.json` configuration file manages the behavior of the **Process Governor** application. This file allows
 users to define rules for regulating process priorities, I/O priorities, and CPU core affinity, as well as manage
 services with similar settings.
 
 The application regularly checks the configuration file for changes and applies the updates accordingly.
 
----
 ## Configuration File Example
 
 Below is an example of the configuration file with several rules defined for processes and services:
@@ -73,9 +72,10 @@ Below is an example of the configuration file with several rules defined for pro
   "version": 3
 }
 ```
+
 </details>
 
----
+<p align="right">(<a href="#document-top">back to top</a>)</p>
 
 ## Structure of the `config.json`
 
@@ -100,7 +100,7 @@ process based on several key parameters:
     - `"Command line"`: Match by command line (e.g., `"App.exe Document.txt"`).
 
 
-- **`selector`** (string): Specifies the name, pattern, or path to the process. 
+- **`selector`** (string): Specifies the name, pattern, or path to the process.
   **Supported wildcards:**
     - `*`: Matches any number of characters.
     - `?`: Matches a single character.
@@ -151,6 +151,8 @@ process based on several key parameters:
     - If not specified, the settings are applied immediately.
     - Positive values set a delay in seconds before applying the settings.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ### `serviceRules`
 
 This section contains a list of rules applied to services. Unlike `processRules`, the **Service Rule** does not include
@@ -175,10 +177,12 @@ in `processRules`.
 This field specifies the version of the configuration. It is required for ensuring proper migration and updates when the
 program configuration changes over time.
 
----
+<p align="right">(<a href="#document-top">back to top</a>)</p>
 
 ## Validation
 
 The configuration file undergoes validation to ensure consistency and correctness. If there are any issues, such as
 invalid parameter combinations or missing required fields, the application will notify the user and prevent the
-configuration from being applied until the errors are resolved.
+configuration from being applied until the errors are resolved.
+
+<p align="right">(<a href="#document-top">back to top</a>)</p>

docs/icons/logo.png

@@ -1,8 +1,11 @@
+<a id="document-top"></a>
+
 # Rule Behavior and Tips
 
-[![README](icons/readme.png) README](README.md)
+[![README](icons/readme.png) README](README.md#documentation)
 
----
+> [!TIP]  
+> Before proceeding, it is recommended to familiarize yourself with [Process Governor UI](ui_process_governor.md).
 
 ## Table of Contents
 
@@ -15,18 +18,16 @@
     - [Optimizing for Older or Single-Threaded Games](#optimizing-for-older-or-single-threaded-games)
     - [Fixing Audio Crackling Issues](#fixing-audio-crackling-issues)
 
----
-
-> **Note:** Before proceeding, it is recommended to familiarize yourself
-> with [Process Governor UI](ui_process_governor.md).
-
 ## Rule Priority
 
 When applying rules, the program first checks **service rules** and then moves to **process rules**. This means that if
 a service matches a rule, it will take precedence. If no matching service rule is found, the program then applies the
 first matching process rule.
 
-> **Note:** Only the first matching rule is applied, so the order of the rules in the configuration is important.
+> [!IMPORTANT]  
+> Only the first matching rule is applied, so the order of the rules in the configuration is important.
+
+<p align="right">(<a href="#document-top">back to top</a>)</p>
 
 ## Ignoring a Process
 
@@ -39,6 +40,8 @@ To ignore a process without applying any specific settings:
 
 This will ensure that the process is excluded from any modifications by the governor.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Rule for All Processes
 
 To apply a rule to all processes:
@@ -49,6 +52,8 @@ To apply a rule to all processes:
 4. Configure the desired settings (e.g., affinity, priority).
 5. Place this rule at the bottom of the list to allow more specific rules to take precedence.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Disabling Hyperthreading
 
 To limit a process to physical CPU cores and disable the use of hyperthreaded (logical) cores:
@@ -60,6 +65,8 @@ To limit a process to physical CPU cores and disable the use of hyperthreaded (l
 
 This will prevent the process from using hyperthreaded cores, which can be beneficial for certain workloads.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Using Delay to Avoid Side Effects
 
 For some applications, especially games, applying settings like core affinity immediately upon startup can cause issues.
@@ -73,6 +80,8 @@ Adding a delay ensures the process has time to initialize before adjustments are
 
 This helps avoid potential problems like sound not working.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Optimizing for Older or Single-Threaded Games
 
 Older or poorly optimized games that don’t efficiently use multiple cores can stutter if run with the default core
@@ -86,6 +95,8 @@ affinity settings. To improve performance:
 
 This setup can help distribute the load more effectively and reduce stuttering.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Fixing Audio Crackling Issues
 
 To address audio crackling or stuttering under high CPU load, it’s recommended to increase the priority of audio-related
@@ -128,10 +139,12 @@ audio tasks, while the first 6 cores (threads 0-11) can be reserved for other ap
     - **Important:** This rule must be placed **last** in the rule list, as it serves as a fallback for any processes
       that are not explicitly defined in previous rules.
 
-> **Note:** Avoid modifying the **Affinity** for audio services like **AudioSrv** or **AudioEndpointBuilder**, as this
+> [!WARNING]  
+> Avoid modifying the **Affinity** for audio services like **AudioSrv** or **AudioEndpointBuilder**, as this
 > may worsen performance. Adjusting the priority for these services is usually sufficient to resolve audio issues such
 > as crackling and stuttering.
 
 This configuration helps distribute the CPU load, isolating audio processes to specific cores, ensuring smoother and
 more stable sound under high system load.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>

docs/images/screenshots/process_list_faded.png

@@ -1,8 +1,8 @@
-# Running from source and creating a portable build
+<a id="document-top"></a>
 
-[![README](icons/readme.png) README](README.md)
+# Running from source and creating a portable build
 
----
+[![README](icons/readme.png) README](README.md#documentation)
 
 ## Running from source code
 
@@ -13,6 +13,8 @@ To run **Process Governor** from source code, follow these steps:
 3. Run the `process-governor.py` script with **administrative privileges**: `python process-governor.py`
 4. [Configure the rules](docs/ui_rule_configurator.md) for processes and services.
 
+<p align="right">(<a href="#document-top">back to top</a>)</p>
+
 ## Creating a portable build
 
 You can create a portable version of the program using **PyInstaller**. Follow these steps to build the portable
@@ -23,3 +25,5 @@ version:
 3. After the script completes, you will find the portable build in the `dist` folder.
 
 Now you have a portable version of the program that you can use without installation.
+
+<p align="right">(<a href="#document-top">back to top</a>)</p>