docs/contribute.md

@@ -1,57 +1,14 @@
 # How to Contribute?
 
-## Issues
 
-* If you encounter any challenges or problems with the script, I kindly request that you submit them via the "Issues" tab on the GitHub repository. By filling out the provided template, you can provide specific details about the issue, allowing me (and others in the community) to promptly address any bugs, or consider feature requests.
+## Testing your changes
+* To test to see if your changes work run the command below in a powershell terminal as Admin after changing to the directory where the WinUtil code is located.
+* `./Compile.ps1`
+* After running that command and it completeing with no errors run the command below.
+* `./winutil.ps1`
+* After seeing that your chnages work properly feel free to make a PR and follow the documentation below.
 
-## Contribute Code
+## Making a PR
-
-* Pull Requests are now handled directly on the **MAIN branch**. This was done since we can now select specific releases to launch via releases in GitHub.
-
-* If you're doing code changes, then you can submit a PR to `main` branch, but I am very selective about these.
-
-> [!WARNING]
-> Do not use a code formatter, massive amounts of line changes, and make multiple feature changes.
-> EACH FEATURE CHANGE SHOULD BE IT'S OWN Pull Request!
-
-* When creating pull requests, it is essential to thoroughly document all changes made. This includes, but not limited to, documenting any additions made to the `tweaks` section and corresponding `undo tweak`, so users are able to remove the newly added tweaks if necessary, and comprehensive documentation is required for all code changes, document your changes and briefly explain why you made your changes in your Pull Request Description. Failure to adhere to this format may result in denial of the pull request. Additionally, Any code lacking sufficient documentation may also be denied.
-
-* By following these guidelines, we can maintain a high standard of quality and ensure that the codebase remains organized and well-documented.
-
-> [!NOTE]
-> When creating a function, please include "WPF" or "WinUtil" in the file name so it can be loaded into the runspace.
-
-## Walk through
-
-### Fork the Repo
-* Fork the WinUtil Repository [here](https://github.com/ChrisTitusTech/winutil) to create a copy that will be available in your Repository-list.
-![Fork](assets/ForkButton.png)
-
-### Clone the Fork 
-* While you can make your changes directly through the Web, we recommend cloning the repo to your device to test your fork easily. 
-* Using the application GitHub Desktop (available in WinUtil) you can easily manage your repos locally. You can do it using other tools like git-cli (available in WinUtil), we recommend GitHub Desktop for ease of use.
-* Install GitHub Desktop if not already installed
-* Log in using the same GitHub account u used to fork WinUtil
-* Choose the fork under "Your Repositories" and press "clone {repo name}"
-* Create a new Branch and name it something relatable to your changes,
-
-* Now you can modify WinUtil to your liking using your prefered text editor.
-
-
-### Testing your changes
-* To test to see if your changes work as intended run following commands in a powershell teminal:
-
-* Change the directory where you are running the commands to the forked project.
-* `cd {path to the folder with the compile.ps1}`
-* Run following command to compile and run Winutil
-* `.\Compile.ps1 -run`
-* After seeing that your changes work properly feel free to commit the changes to the repository and make a PR, for help on that follow the documentation below.
-
-### Commiting the changes
-* Commit your changes once you are fine with the result
-* Push the changes to "upload" them to your fork on github.com.
-
-### Making a PR
 * To make a PR on your repo under a new branch linking to the main branch a button will show and say Preview and Create pull request. Click that button and fill in all information that is provided on the template. Once all the information is filled in correctly check your PR to make sure there is not a WinUtil.ps1 file attached to the PR. Once everything is good make the PR and wait for Chris (The Maintainer) to accept or deny your PR. Once it is accepted in by Chris you will be able to see your changes in the /windev build.
 * If you do not see your feature in the main /win build that is fine. As all new changes go into the /windev build to make sure everything is working ok before going fully public.
 * Congrats you just submitted your first PR. Thank you so much for contributing to WinUtil.

docs/index.md

@@ -1,6 +1,4 @@
-# Welcome to Chris Titus WinUtil Offical Documentation!
+# Welcome to Chris Titus WinUtil Docs!
-
-[![](https://dcbadge.limes.pink/api/server/https://discord.gg/RUbZUZyByQ)](https://discord.gg/RUbZUZyByQ)
 
 ## Running
 

docs/userguide.md

@@ -1,97 +1,76 @@
 # User Guide
 
 ## Overview
-* short one
 
+## Program
 
-## Walkthrough
+### Installation & Updates
-
-### Program
-
-#### Installation & Updates
 * To install programs select the programs you wish to install or update like the picture below.
 ![Program Install](assets/ProgramInstall.png)
 * Once you have selected the programs you wish to install click the select Install/Upgrade Selected button as seen below.
 ![Program Install Button](assets/ProgramInstallButton.png)
 
-#### Upgrade All
+### Upgrade All
 * Press the button to upgrade all installed programs that are supported by WinGet, there is no selection needed.
 
-#### Uninstall
+### Uninstall
 * To uninstall programs select the programs you wish to uninstall like the picture below.
 ![Program Uninstall](assets/ProgramInstall.png)
 * Once you have selected the programs you wish to uninstall click the select Uninstall Selected button as seen below.
 ![Program Uninstall Button](assets/ProgramUninstall.png)
 
-#### Get Installed
+### Get Installed
 * Checks for installed programs that are supported by WinGet and selects them in the Utility.
 
-#### Clear Selection
+### Clear Selection
 * Clears ur current selection so no program is checked.
 
-### Tweaks
+## Tweaks
 
-#### Tweaks Addition
+### Tweaks Addition
 * To enable tweaks on your system select Tweaks at the top next to Install.
 * Then you can select what tweaks you want adding to your system. We do have some presets you can select from at the top you can see this in the picture below. 
 ![Tweaks Screen](assets/TweaksScreen.PNG)
-* After you have chosen your tweaks click the Run Tweaks button at the bottom of the screen.
+* After you have chosen your tweaks click the 
 
-#### Tweaks Removal
+### Tweaks Removal
 * To disable tweaks on your system select Tweaks at the top next to Install.
 * Then you can select what tweaks you want removing from your system.
-* After you have chosen your tweaks you want to remove click the Undo Selected Tweaks button at the bottom of the screen.
 
-#### Essential Tweaks
+### Essential Tweaks
-* The Tweaks under the Essential
 
-#### Advanced Tweaks - CAUTION
+### Advanced Tweaks - CAUTION
 
-#### O&O Shutup
+### O&O Shutup
 
-#### DNS
+### DNS
 
-#### Customize Preferences
+### Customize Preferences
 
-#### Performance Plans
+### Performance Plans
 
-#### Shortcuts
+### Shortcuts
 
 
 ![Tweaks Screen](assets/TweaksScreen.PNG)
 
-### Config
+## Config
 
-#### Features
+### Features
 * Install the most used Windows Features by checking the checkbox and clicking "Install Features" to install them
 
-#### Fixes
+### Fixes
 * Quick Fixes for your system if you are having Issues.
 
-* Set Up Autologin
+- Set Up Autologin
-* Reset Windows Update
+- Reset Windows Update
-* Reset Network
+- Reset Network
-* System Corruption Scan
+- System Corruption Scan
-* WinGet Reinstall
+- WinGet Reinstall
-* Remove Adobe Creative Cloud
+- Remove Adobe Creative Cloud
 
-#### Legacy Windows Panels
+### Legacy Windows Panels
 
-### Updates | Not working rn
+## Updates | Not working rn
 
-### MicroWin
+## MicroWin
-
-## Automation
-
-* Some features are available through automation. This allows you to save your config file pass it to Winutil walk away and come back to a finished system. Here is how you can set it up currently with Winutil >24.01.15
-
-* On the Install Tab, click "Get Installed", this will get all installed apps **supported by Winutil** on the system
-![GetInstalled](assets/Get-Installed.png)
-* Click on the Settings cog in the upper right corner and chose Export, chose file file and location, this will export the setting file.
-![SettingsExport](assets/Settings-Export.png)
-* Copy this file to a USB or somewhere you can use after Windows installation.
-* Use Microwin tab to create a custom Windows image.
-* Install the Windows image.
-* In the new Windows, Open PowerShell in the admin mode and run command to automatically apply tweaks and install apps from the config file.
-* ``` iex "& { $(irm christitus.com/win) } -Config [path-to-your-config] -Run" ```
-* Have a cup of coffee! Come back when it's done.

mkdocs.yml

@@ -1,4 +1,4 @@
-site_name: Chris Titus WinUtil Official Documentation
+site_name: Chris Titus WinUtil Docs
 repo_url: https://github.com/ChrisTitusTech/winutil
 
 nav:
@@ -10,7 +10,6 @@ nav:
 
 theme:
   name: material
-  custom_dir: 'overrides'
   features:
     - navigation.tabs
     - navigation.sections
@@ -22,8 +21,8 @@ theme:
     - content.code.annotation
     - content.code.copy
   language: en
-  logo: assets/favicon.png
+  logo: img/favicon.png
-  favicon: assets/favicon.png
+  favicon: img/favicon.png
   palette:
     - scheme: default
       toggle:
@@ -37,5 +36,3 @@ theme:
         name: Switch to light mode    
       primary: teal
       accent: lime
-  markdown_extensions:
-    - admonition

overrides/main.html

@@ -2,11 +2,7 @@
 
 {% block header %}
 {{ super() }}
-    <div style="color: red; text-align: center; padding: 10px; font-size: 20px;">
+<div style="color: white; text-align: center; padding: 10px; font-size: 20px;">
-        <strong>Announcement:</strong> This documentation is still in progress.
+    <strong>Announcement:</strong> This documentation is still in working progress.
 </div>
 {% endblock %}
-
-{% block footer %}
-    {# Empty block to override the footer #}
-{% endblock %}