updates to final docs fixed some broken links tested build deployment

Author: AdamG100

README.md

@@ -1,23 +1,64 @@
 # TCAdmin Documentation
 
-Welcome to the official documentation for TCAdmin! This repository contains comprehensive documentation for TCAdmin, a leading control panel for game server hosting. This README provides an overview of the documentation structure and how to contribute to its improvement.
+Welcome to the TCAdmin documentation repository! This repository contains comprehensive documentation for various aspects of the TCAdmin platform. Whether you're new to TCAdmin or an experienced user, this guide will walk you through different processes and functionalities.
 
-## Table of Contents
+## Getting Started with GitHub Desktop
 
-**TO DO STILL**
+To contribute to the TCAdmin documentation using GitHub Desktop, follow these steps:
 
-## About TCAdmin
+### 1. Fork the Repository
 
-TCAdmin is a powerful and user-friendly control panel designed for game server administrators and hosting providers. It offers a wide range of features to simplify the management of game servers, including server deployment, configuration, monitoring, and more. With TCAdmin, you can easily manage multiple game server instances, control access and permissions, and provide an intuitive user interface for your customers.
+1. Click the "Fork" button at the top right corner of this repository. This action will create a copy of the repository in your GitHub account.
 
-For more information about TCAdmin, please visit the [official website](https://www.tcadmin.com/).
+### 2. Clone the Repository
 
-## Documentation Structure
+1. Download and install [GitHub Desktop](https://desktop.github.com/) if you haven't already.
+2. Click the "Clone a repository" button in GitHub Desktop.
+3. Select the "tcadmin-docs" repository from the list and choose a local path where you want to clone the repository.
 
-The TCAdmin documentation is organized into the following main sections:
+### 3. Make Changes
 
-**TO DO STILL**
+1. Open the cloned repository in GitHub Desktop.
+2. Create a new branch for your changes by clicking on the "Current branch" dropdown and selecting "New Branch." Give your branch a descriptive name related to the changes you'll be making.
+3. Make the necessary updates to the documentation using your preferred text editor.
 
-## Contributing
+### 4. Commit and Push Changes
 
-We welcome contributions to enhance the TCAdmin documentation. If you find any errors, typos, or missing information, or if you would like to propose improvements
+1. After making changes, return to GitHub Desktop.
+2. You will see your changes listed under "Changes."
+3. Add a summary and description of your changes in the provided fields.
+4. Click the "Commit to \<branch name\>" button to commit your changes to the new branch.
+5. Click the "Push origin" button to push your changes to your forked repository on GitHub.
+
+### 5. Create a Pull Request
+
+1. After pushing your changes, you'll see a banner in GitHub Desktop suggesting you create a pull request. Click the "Create Pull Request" button.
+2. This action will open your web browser and take you to the pull request page on GitHub. Provide a clear title and description for your pull request, summarizing the changes you've made.
+
+### 6. Review and Merge
+
+Our team will review your pull request, offer feedback if necessary, and once everything looks good, your changes will be merged into the main documentation repository.
+
+Thank you for contributing to the TCAdmin documentation!
+
+## Additional Notes
+
+- Please follow the [Markdown style guide](https://www.markdownguide.org/basic-syntax/) when writing and formatting documentation content.
+
+- For any questions or assistance, feel free to reach out to us by creating an issue in this repository.
+
+## How to Submit an Issue or Suggestion
+
+To submit an issue or suggestion, please follow these steps:
+
+1. **Check for existing issues**: Before submitting a new issue or suggestion, please search the tracker to ensure that it hasn't been reported or suggested before. This helps us avoid duplicates and allows us to focus on resolving unique problems and implementing new ideas.
+
+2. **Create a new issue**: If you couldn't find a similar issue or suggestion, click on the ["Issues"](../../issues) tab above and then click the ["New Issue"](../../issues/new/choose) button. Provide a descriptive title that summarizes the problem or suggestion concisely.
+
+3. **Provide details**: In the issue description, provide as much information as possible to help us understand the problem or suggestion. Include clear steps to reproduce the issue or a detailed explanation of the enhancement you're suggesting. You can also attach relevant screenshots or files to support your submission.
+
+4. **Label and assign**: Once you've created the issue, please assign the appropriate labels that best categorize the problem or suggestion. This helps us organize and prioritize the issues accordingly. If you're a team member responsible for managing this tracker, you can assign the issue to yourself or the relevant person for further action.
+
+5. **Engage in discussion**: Feel free to engage in the discussion by providing additional details, asking questions, or clarifying any points raised by other community members or our team. Your input is valuable, and together we can find the best solutions and ideas.
+
+6. **Track progress**: As we work on addressing the issues or implementing the suggestions, we will update the status and provide relevant comments. You can subscribe to notifications to stay informed about the progress.

docs/billing-api/tcadmin2-advanced-module-for-whmcs.mdx

@@ -320,4 +320,70 @@ case "2GB":
 - Change the value of package_id to the id of the package you want to assign.
 - Select your reseller product in WHMCS. In the module settings tab set the config file to reseller.php
 
-### Other configuration parameters
+### Other configuration parameters
+
+- **game_start / voice_start**
+  - Start the service after it has been created.
+  - Allowed values are 1 and 0.
+  - The default value is 1.
+
+- **game_startup / voice_startup**
+  - Specify the service's startup.
+  - Allowed values are Automatic, Manual, Disabled.
+  - The default value is Automatic.
+
+- **game_additional_slots / voice_additional_slots**
+  - Value added to game_slots.
+  - Default value is 0.
+
+- **game_priority / voice_priority**
+  - Specify the CPU priority.
+  - Allowed values are Idle, BelowNormal, Normal, AboveNormal, High, RealTime.
+  - The default value is Normal.
+
+- **game_server / voice_server**
+  - Specify the server id for service creation.
+  - Can be used instead of game_datacenter.
+
+- **game_cpu / voice_cpu**
+  - Specify a value from 1 to 100 (Windows) or 1 to (100 x number of processors) (Linux).
+  - See [Limit Service CPU and Memory Usage **(Windows)**](/misc/limit-service-cpu-andmemory-usage#windows).
+  - See [Limit Service CPU and Memory Usage **(Linux)**](/misc/limit-service-cpu-andmemory-usage#linux).
+
+- **game_memory / voice_memory**
+  - Specify the max allowed memory in MB.
+
+- **game_virtual_memory / game_virtual_memory**
+  - Specify the max allowed virtual memory in MB (Windows only).
+
+### Specifying Different Module Value and Display Value
+
+In WHMCS, you can configure dropdowns and radios to send a different value to the module than the one that is displayed in the order form. This is useful because you must send ids to the TCAdmin billing api but you want to show a friendly name to the client. The module value and display value are separated by the pipe character "|". The format is ModuleValue|DisplayValue For example: You can create a dropdown list that has the locations New York and Dallas but you want the billing api to receive the datacenter ids 1 and 2. You can create a `Custom Field` of type `Drop Down` with these options: 1|Dallas,2|NewYork
+
+### Troubleshooting
+
+- The values sent to TCAdmin are saved in the log file `/home/tcadmin/Logs/Web/BillingApi.LastCommand.log` or `C:\Program Files\TCAdmin2\Logs\Web\BillingApi.LastCommand.log` Make sure TCAdmin is receiving the correct values. The values required to create a game server are: game_id, game_slots, game_datacenter.
+- If TCAdmin accepts the values a scheduled task is created. If the game server is never created go to System > General Settings > Scheduled Tasks. Select the Day view and click on the task that was created. You should see the error message preventing the game server from being created. Correct the problem and start the task again. You don't need to send the command from WHMCS again.
+
+### Update Products and Services from tcadmin to tcadmin2_advanced
+
+If you are going to keep the same custom fields and configurable options in your products you need to follow these steps:
+- Update the module settings in the product. Switch from tcadmin to tcadmin2_advanced module and map the required tcadmin attributes to custom fields and configurable options.
+- Update the server field in the client's service.
+
+If you are going to change custom fields and configurable options we recommend you create a copy of the product and modify the copy (Duplicate link at the top of the products page). When the new product is ready go to the client's service. Change the package and server. Enter the correct values again and save.
+
+:::warning warning
+After you change the package all the values of custom fields and configurable options for that service will be lost and you will not be able to recover them.
+:::
+
+To enable direct client login from WHMCS to TCAdmin you must configure the service’s username and password. To disable this feature leave the username and password fields blank.
+
+### Cloudflare
+
+If Cloudflare is blocking requests to the billing api go to the `Cloudflare control panel` > Security > Web Application Firewall (WAF) > Tools and allow your WHMCS IP.
+
+![WHMCS_WAF](/img/billing-api/WHMCS_WAF.png)
+
+![WHMCS_WAF2](/img/billing-api/WHMCS_WAF2.png)
+

docs/customizations/modules/sample-module.mdx

@@ -11,7 +11,7 @@ This is an example of a module that can be installed onto your master which will
 
 ### Sample View Page - HelloWorld.cshtml
 
-```html showLineNumbers
+```cshtml showLineNumbers
 @model Game.HelloWorldModel
 @{
     Layout = this.GetTemplateFile("Shared/Main.cshtml", true);

docs/customizations/scripts/custom-protocols/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Custom Protocols",
-  "position": 2,
+  "position": 3,
   "link": {
     "type": "generated-index",
     "description": "TCAdmin Custom Protocols"

docs/customizations/scripts/general-scripts/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "General Scripts",
+  "position": 1,
+  "link": {
+    "type": "generated-index",
+    "description": "General Scripts for TCAdmin"
+  }
+}

…ons/scripts/allow-user-to-change-exe.mdx …ral-scripts/allow-user-to-change-exe.mdxdocs/customizations/scripts/allow-user-to-change-exe.mdx renamed to docs/customizations/scripts/general-scripts/allow-user-to-change-exe.mdx docs/customizations/scripts/allow-user-to-change-exe.mdx renamed to docs/customizations/scripts/general-scripts/allow-user-to-change-exe.mdx

@@ -6,12 +6,12 @@ sidebar_label: Backup & Restore Scripts with FTP Support
 # Backup & Restore Scripts with FTP Support
 
 :::info
-These scripts are a modified version of [Backup & Restore_Scripts](/customizations/scripts/backup-restore-scripts). Instead of keeping a local copy of the zip it will get uploaded to FTP. Locally in the backups folder you will see a zip with 0 bytes. This is used to remember which files have been uploaded.
+These scripts are a modified version of [Backup & Restore_Scripts](/customizations/scripts/general-scripts/backup-restore-scripts). Instead of keeping a local copy of the zip it will get uploaded to FTP. Locally in the backups folder you will see a zip with 0 bytes. This is used to remember which files have been uploaded.
 :::
 
 ## Secure your Backups folder
 
-:::danger Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
+:::warning Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
 Failure to execute this pivotal step in the configuration process will render your server alarmingly susceptible to exploitations and security breaches.
 :::
 

…s/scripts/allow-user-to-change-slots.mdx …l-scripts/allow-user-to-change-slots.mdxdocs/customizations/scripts/allow-user-to-change-slots.mdx renamed to docs/customizations/scripts/general-scripts/allow-user-to-change-slots.mdx docs/customizations/scripts/allow-user-to-change-slots.mdx renamed to docs/customizations/scripts/general-scripts/allow-user-to-change-slots.mdx

@@ -7,7 +7,7 @@ sidebar_label: Backup & Restore Scripts
 
 ## Secure your Backups folder
 
-:::danger Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
+:::warning Urgent Warning: Critical Configuration Step - Neglect at Your Peril!
 Failure to execute this pivotal step in the configuration process will render your server alarmingly susceptible to exploitations and security breaches.
 :::