diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 997ed41c..7bccbc18 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -30,7 +30,7 @@ jobs: if: github.repository == 'ChrisTitusTech/winutil' runs-on: ubuntu-latest env: - HUGO_VERSION: 0.147.7 + HUGO_VERSION: 0.156.0 HUGO_ENVIRONMENT: production TZ: America/Chicago steps: diff --git a/docs/content/KnownIssues.md b/docs/content/KnownIssues.md index 228add90..2f11625d 100644 --- a/docs/content/KnownIssues.md +++ b/docs/content/KnownIssues.md @@ -15,10 +15,10 @@ If you are seeing errors referencing TLS or security, you may be running an olde ``` [Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 -iex https://christitus.com/win | iex +irm https://christitus.com/win | iex ``` -If it still isn't working and you live in India, it might be due to India blocking GitHub's content domain and preventing downloads. See more on [Times of India](https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms). +If it still isn't working in your region, it may be due to temporary ISP or network filtering of GitHub content domains. This has been reported by some users in India in the past. See: [Times of India](https://timesofindia.indiatimes.com/gadgets-news/github-content-domain-blocked-for-these-indian-users-reports/articleshow/96687992.cms). If you are still having issues, try using a **VPN**, or changing your **DNS provider** to one of following two providers: @@ -37,7 +37,7 @@ If it returns `ConstrainedLanguage`, you may need to switch to `FullLanguage` mo ### Script blocked by Execution Policy -1. Ensure you are running PowerShell as admin: Press `Windows Key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. +1. Ensure you are running PowerShell as admin: Press `Windows key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. 2. In the PowerShell window, type this to allow unsigned code to execute and run the installation script: ``` @@ -65,7 +65,7 @@ This could be for a number of reasons: If that doesn't work, disable Hibernation: -- Press `Windows Key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. then type: +- Press `Windows key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11, then type: ```bat powercfg /H off @@ -89,11 +89,11 @@ Related issue: [#198](https://github.com/ChrisTitusTech/Winutil/issues/198) ### Windows 11: Quick Settings no longer works -Launch the Script and click _Enable Action Center_. +Launch the script and click _Enable Action Center_. ### Explorer (file browser) no longer launches -- Press `Windows key`+`R` then type: +- Press `Windows key`+`R`, then type: ```bat control /name Microsoft.FolderOptions @@ -106,7 +106,7 @@ Launch the Script and click _Enable Action Center_. If you're using a laptop or tablet and find your battery drains too fast, please try the below troubleshooting steps, and report the results back to the Winutil community. 1. **Check Battery Health:** - - Press `Windows Key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. + - Press `Windows key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. - Run the following command to generate a battery report: ```powershell powercfg /batteryreport /output "C:\battery_report.html" @@ -114,7 +114,7 @@ If you're using a laptop or tablet and find your battery drains too fast, please - Open the generated HTML report to review information about battery health and usage. A battery with poor health may hold less charge, discharge faster, or cause other issues. 2. **Review Power Settings:** - - Open the Settings app, and go to _System_ > _Power & sleep_. + - Open Settings and go to _System_ > _Power & battery_ (Windows 11) or _System_ > _Power & sleep_ (Windows 10). - Adjust power plan settings based on your preferences and usage patterns. - Click on _Additional power settings_ to access advanced power settings that may help. @@ -128,7 +128,7 @@ If you're using a laptop or tablet and find your battery drains too fast, please - Ensure graphics, chipset, and other essential drivers are up to date. 5. **Check for Windows Updates:** - - Open the Settings app, and go to _Update & Security_ > _Windows Update_. + - Open Settings and go to _Windows Update_ (Windows 11) or _Update & Security_ > _Windows Update_ (Windows 10). - Check for and install any available updates for your operating system. 6. **Reduce Screen Brightness:** @@ -144,11 +144,11 @@ If you're using a laptop or tablet and find your battery drains too fast, please - Review the list of apps and their power usage. Disable or uninstall any you don't need. 9. **Check Background Apps:** - - Open the Settings app, and go to _Privacy_ > _Background apps_. + - Review background app permissions in Settings (location varies by Windows version and app type). - Disable or uninstall unnecessary apps running in the background. 10. **Use `powercfg` for Analysis:** - - Press `Windows Key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. + - Press `Windows key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. - Run the following command to analyze energy usage and generate a report: ```powershell powercfg /energy /output "C:\energy_report.html" @@ -161,7 +161,7 @@ If you're using a laptop or tablet and find your battery drains too fast, please - Look for events with the source _Power-Troubleshooter_ to identify power-related events. These may highlight battery, input power, and other issues. 12. **Check Wake-up Sources:** - - Press `Windows Key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. + - Press `Windows key`+`X` and select _PowerShell (Admin)_ in Windows 10, or `Windows Terminal (Admin)` in Windows 11. - Use the command `powercfg /requests` to identify processes preventing sleep. - Use the command `powercfg /waketimers` to view active wake timers. - Check Task Scheduler to see if any of the discovered processes are scheduled to start on boot or at regular intervals. @@ -172,7 +172,7 @@ If you're using a laptop or tablet and find your battery drains too fast, please - Consider reconfiguring, closing, disabling, or uninstalling applications that use a lot of resources. 14. **Disable Activity History:** - - Open the Settings app, and go to _Privacy_ > _Activity history_. + - Open Settings and go to _Privacy & security_ > _Activity history_ (Windows 11) or _Privacy_ > _Activity history_ (Windows 10). - Turn off _Let Windows collect my activities from this PC_. 15. **Prevent Network Adapters From Waking PC:** diff --git a/docs/content/userguide/_index.md b/docs/content/userguide/_index.md index e61871dd..9092b5dd 100644 --- a/docs/content/userguide/_index.md +++ b/docs/content/userguide/_index.md @@ -31,7 +31,7 @@ Winutil is designed for: New to Winutil? Start here: 1. **[Getting Started Guide](getting-started/)** - Installation and first steps -2. **[Application Store](application/)** - Learn to install software easily +2. **[Applications Guide](application/)** - Learn to install, upgrade, and uninstall software 3. **[Tweaks Guide](tweaks/)** - Optimize your system 4. **[Features & Fixes](features/)** - Troubleshoot common issues 5. **[Win11 Creator](win11Creator/)** - Build a custom debloated Windows 11 ISO @@ -42,7 +42,7 @@ New to Winutil? Start here: Browse and install hundreds of popular applications with a single click. No more hunting for download links or dealing with installer bloat. -**[Read the Store Guide →](application/)** +**[Read the Applications Guide →](application/)** ### ⚙️ System Tweaks @@ -91,7 +91,7 @@ Build a custom Windows 11 ISO with bloatware removed, telemetry disabled, and ha | I want to... | Go to... | |--------------|----------| | Install Winutil for the first time | [Getting Started](getting-started/) | -| Install applications quickly | [Application Store](application/) | +| Install, upgrade, or uninstall apps | [Applications Guide](application/) | | Speed up my computer | [Tweaks Guide](tweaks/) | | Fix Windows Update problems | [Features - Fixes](features/) | | Automate setup for multiple PCs | [Automation](automation/) | @@ -151,7 +151,7 @@ Want to help improve Winutil? This User Guide covers everything you need to know: 1. **[Getting Started](getting-started/)** - Installation, first run, basic usage -2. **[Application Store](application/)** - Installing software, using presets +2. **[Applications](application/)** - Installing, upgrading, and uninstalling software 3. **[Tweaks](tweaks/)** - System optimizations and customizations 4. **[Features & Fixes](features/)** - Troubleshooting tools and utilities 5. **[Win11 Creator](win11Creator/)** - Build a custom debloated Windows 11 ISO diff --git a/docs/content/userguide/application/_index.md b/docs/content/userguide/application/_index.md index f4bf9d09..85231447 100644 --- a/docs/content/userguide/application/_index.md +++ b/docs/content/userguide/application/_index.md @@ -1,33 +1,33 @@ --- title: Applications -weight: 2 +weight: 3 --- -{{< tabs items="Installation & Updates,Upgrade All,Uninstall,Get Installed,Clear Selection" defaultIndex="0" >}} +{{< tabs >}} - {{< tab >}} - * Choose the programs you want to install or upgrade. + {{< tab name="Installation & Updates" selected=true >}} + * Choose the applications you want to install or upgrade. * For programs not currently installed, this action will install them. * For programs already installed, this action will update them to the latest version. * Click the `Install/Upgrade Selected` button to start the installation or upgrade process. {{< /tab >}} - {{< tab >}} + {{< tab name="Upgrade All" >}} * Simply press the `Upgrade All` button. * This will upgrade all applicable programs that are installed without the need for individual selection. {{< /tab >}} - {{< tab >}} + {{< tab name="Uninstall" >}} * Select the programs you wish to uninstall. * Click the `Uninstall Selected` button to remove the selected programs. {{< /tab >}} - {{< tab >}} + {{< tab name="Get Installed" >}} * Click the `Show Installed Apps` button. - * This will scan for and select all installed programs in Winutil that WinGet supports. + * This scans for and selects installed applications supported by WinGet. {{< /tab >}} - {{< tab >}} + {{< tab name="Clear Selection" >}} * Click the `Clear Selection` button. * This will unselect all checked programs. {{< /tab >}} diff --git a/docs/content/userguide/automation/_index.md b/docs/content/userguide/automation/_index.md index 553f6ab8..c44aae00 100644 --- a/docs/content/userguide/automation/_index.md +++ b/docs/content/userguide/automation/_index.md @@ -1,7 +1,13 @@ -Automation option in winutil allows you to run winutil from a config file, -you can get your own config file inside winutil by clicking the gear icon on the top right and clicking export and saving it as a file +--- +title: Automation +weight: 7 +--- -you can automate winutil launch with this command +The Automation option in Winutil allows you to run Winutil from an exported config file. + +You can create your own config in the app by clicking the gear icon in the top-right corner, then choosing Export and saving the file. + +You can automate Winutil launch with this command: ```powershell -& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Config C:\Path\To\Config -Run +& ([ScriptBlock]::Create((irm "https://christitus.com/win"))) -Config "C:\Path\To\Config.json" -Run ``` diff --git a/docs/content/userguide/features/_index.md b/docs/content/userguide/features/_index.md index 11718e70..7a8d692d 100644 --- a/docs/content/userguide/features/_index.md +++ b/docs/content/userguide/features/_index.md @@ -1,12 +1,12 @@ --- title: Features -weight: 4 +weight: 5 --- -* Install the most used **Windows Features** by checking the checkbox and clicking "Install Features" to install them. +Install common **Windows Features** by selecting the feature checkboxes and clicking **Install Features**. -* All .Net Frameworks (2, 3, 4) -* HyperV Virtualization +* All .NET Frameworks (2, 3, 4) +* Hyper-V Virtualization * Legacy Media (WMP, DirectPlay) * NFS - Network File System * Enable Daily Registry Backup Task 12:30am @@ -16,7 +16,7 @@ weight: 4 * Windows Sandbox ### Fixes -* Quick fixes for your system if you are having issues. +Quick fixes for common system problems. * Set Up Autologin * Reset Windows Update @@ -28,6 +28,7 @@ weight: 4 ### Legacy Windows Panels Open old-school Windows panels directly from Winutil. Following Panels are available: +Open classic Windows panels directly from Winutil. Available panels include: * Control Panel * Network Connections @@ -39,4 +40,4 @@ Open old-school Windows panels directly from Winutil. Following Panels are avail ### Remote Access -Enables OpenSSH server on your windows machine. +Enables an OpenSSH server on your Windows machine. diff --git a/docs/content/userguide/getting-started/_index.md b/docs/content/userguide/getting-started/_index.md index d5b6c8d2..e20f2cf2 100644 --- a/docs/content/userguide/getting-started/_index.md +++ b/docs/content/userguide/getting-started/_index.md @@ -1,6 +1,6 @@ --- title: Getting Started -weight: 1 +weight: 2 --- ## Welcome to Winutil! @@ -111,7 +111,7 @@ This allows you to undo changes if needed. 1. Navigate to the **Install** tab 2. Browse categories or use the search bar 3. Check applications you want to install -4. Click "Install Selected" at the bottom +4. Click "Install/Upgrade Selected" at the bottom ### 3. Apply Basic Tweaks @@ -131,7 +131,7 @@ For a better Windows experience without risks: 1. Open **Install** tab 2. Search for the application name 3. Check the box next to it -4. Click "Install Selected" +4. Click "Install/Upgrade Selected" **Multiple Applications**: @@ -239,7 +239,7 @@ irm "https://christitus.com/win" | iex ### Download Blocked (India/Certain Regions) -If GitHub is blocked in your region: +If downloads are blocked in your region: 1. Use a VPN service 2. Change DNS to Cloudflare (1.1.1.1) or Google (8.8.8.8) @@ -258,7 +258,7 @@ If Winutil downloads but doesn't open: Now that you're set up, explore these guides: -- [Application Installation Guide](../application/) - Learn about installing software +- [Application Guide](../application/) - Learn about installing, upgrading, and uninstalling software - [Tweaks Guide](../tweaks/) - Understand system optimizations - [FAQ](../../faq/) - Common questions and answers @@ -276,7 +276,8 @@ If you need assistance: | Task | Location | Action | | -------------------- | ----------- | ------------------------------------ | -| Install Apps | Install Tab | Check boxes → Install Selected | +| Install or upgrade apps | Install Tab | Check boxes → Install/Upgrade Selected | +| Uninstall apps | Install Tab | Check boxes → Uninstall Selected | | Apply Tweaks | Tweaks Tab | Select tweaks → Run Tweaks | | Undo Tweaks | Tweaks Tab | Select tweaks → Undo Selected Tweaks | | Create Restore Point | Tweaks Tab | Essential Tweaks section | @@ -284,4 +285,4 @@ If you need assistance: | Change DNS | Tweaks Tab | DNS section | | Open Control Panel | Config Tab | Legacy Windows Panels | -Happy optimizing! 🚀 +Happy optimizing! 🚀 \ No newline at end of file diff --git a/docs/content/userguide/tweaks/_index.md b/docs/content/userguide/tweaks/_index.md index 48e38cbb..742864a5 100644 --- a/docs/content/userguide/tweaks/_index.md +++ b/docs/content/userguide/tweaks/_index.md @@ -1,6 +1,6 @@ --- title: Tweaks -weight: 3 +weight: 4 --- {{< image src="images/Tweaks-Tab" alt="Image of Tweaks Tab" >}} @@ -21,10 +21,10 @@ Essential Tweaks are modifications and optimizations that are generally safe for ### Advanced Tweaks (CAUTION) Advanced Tweaks are intended for experienced users who have a solid understanding of their system and the potential implications of making deep-level changes. These tweaks involve more significant alterations to the operating system and can provide substantial customization. However, they also carry a higher risk of causing system instability or unintended side effects if not implemented correctly. Users who choose to apply Advanced Tweaks should proceed with caution, ensuring they have adequate knowledge and backups in place to recover if something goes wrong. These tweaks are not recommended for novice users or those unfamiliar with the inner workings of their operating system. -### O&O Shutup +### O&O ShutUp10++ -[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from Winutil with only one button click. It is a free privacy tool for Windows that lets users easily manage their privacy settings. It disables telemetry, controls updates, and manages app permissions to enhance security and privacy. The tool offers recommended settings for optimal privacy with just a few clicks. +[O&O ShutUp10++](https://www.oo-software.com/en/shutup10) can be launched from Winutil with one click. It is a free privacy tool for Windows that helps users manage telemetry, update behavior, and app permission settings. {{< youtube id=3HvNr8eMcv0 loading=lazy >}} @@ -46,11 +46,11 @@ The utility provides a convenient DNS selection feature, allowing users to choos ### Customize Preferences -The Customize Preferences section allows users to personalize their Windows experience by toggling various visual and functional features. These preferences are designed to enhance usability and tailor the system to the user’s specific needs and preferences. +The Customize Preferences section allows users to personalize their Windows experience by toggling visual and functional settings. ### Performance Plans -The Performance Plans section allows users to manage the Ultimate Performance Profile on their system. This feature is designed to optimize the system for maximum performance. +The Performance Plans section allows users to manage the Ultimate Performance Profile for maximum performance. #### Add and activate the Ultimate Performance Profile: * Enables and activates the Ultimate Performance Profile to enhance system performance by minimizing latency and increasing efficiency. diff --git a/docs/content/userguide/updates/_index.md b/docs/content/userguide/updates/_index.md index ba5b4962..10eab42a 100644 --- a/docs/content/userguide/updates/_index.md +++ b/docs/content/userguide/updates/_index.md @@ -1,3 +1,8 @@ +--- +title: Updates +weight: 6 +--- + The utility provides three distinct settings for managing Windows updates: Default (Out of Box) Settings, Security (Recommended) Settings, and Disable ALL Updates (NOT RECOMMENDED!). Each setting offers a different approach to handling updates, catering to various user needs and preferences. ### Default (Out of Box) Settings diff --git a/docs/content/userguide/win11Creator/_index.md b/docs/content/userguide/win11Creator/_index.md index 3c189897..e06dd09c 100644 --- a/docs/content/userguide/win11Creator/_index.md +++ b/docs/content/userguide/win11Creator/_index.md @@ -1,6 +1,6 @@ --- title: Win 11 Creator -weight: 5 +weight: 8 --- ## Using Winutil's Win11 Creator @@ -40,7 +40,7 @@ Click **Run Windows ISO Modification and Creator** to start the customization pr - **Delete OneDrive setup** from the image **System Customization:** -- **Bypass hardware checks** — removes TPM, Secure Boot, CPU, and RAM requirement enforcement so the ISO installs on unsupported hardware +- **Bypass hardware checks** — removes TPM, Secure Boot, CPU, RAM, and storage requirement enforcement so the ISO installs on unsupported hardware - **Enable local account setup** — injects an `autounattend.xml` that skips the Microsoft account screen during OOBE - **Disable BitLocker and device encryption** — removes startup overhead - **Disable Chat icon** — removes chat taskbar button @@ -69,9 +69,9 @@ A live log shows progress as each step completes. This stage takes **10–30 min Once modification is complete, choose how to save your image: -{{< tabs items="Save as ISO,Write to USB" defaultIndex="0" >}} +{{< tabs >}} - {{< tab >}} + {{< tab name="Save as ISO" selected=true >}} 1. Click **Save as an ISO File**. 2. Choose a save location (defaults to your Desktop as `Win11_Modified_yyyyMMdd.iso`). 3. Winutil builds a dual BIOS/UEFI bootable ISO using `oscdimg.exe`. @@ -82,7 +82,7 @@ Once modification is complete, choose how to save your image: **Typical output size:** 2.5–3.5 GB (down from 5–6 GB original) {{< /tab >}} - {{< tab >}} + {{< tab name="Write to USB" >}} 1. Click **Write Directly to a USB Drive**. 2. Select your USB drive from the dropdown (click **Refresh** if it doesn't appear). 3. Click **Erase & Write to USB** and confirm the warning — **all data on the drive will be permanently erased**. @@ -161,7 +161,7 @@ A list of the best free and open source tools for downloading, creating and flas --- > [!TIP] -> Already have a Windows 11 ISO? Skip the third-party tools and use Winutil's built-in **[Win11 Creator](#using-winutilss-win11-creator)** at the top of this page. +> Already have a Windows 11 ISO? Skip the third-party tools and use Winutil's built-in **[Win11 Creator](#using-winutils-win11-creator)** at the top of this page. > [!NOTE] > Always download Windows ISOs from official Microsoft sources or trusted tools like Rufus/UUP Dump to avoid tampered images. diff --git a/docs/go.mod b/docs/go.mod index 06806674..afe5b6ea 100644 --- a/docs/go.mod +++ b/docs/go.mod @@ -1,5 +1,5 @@ module github.com/ChrisTitusTech/WinUtil -go 1.23.3 +go 1.26 -require github.com/imfing/hextra v0.11.1 // indirect +require github.com/imfing/hextra v0.12.0 // indirect diff --git a/docs/go.sum b/docs/go.sum index d49a8e92..b74684f9 100644 --- a/docs/go.sum +++ b/docs/go.sum @@ -2,3 +2,5 @@ github.com/imfing/hextra v0.9.7 h1:Zg5n24us36Bn/S/5mEUPkRW6uwE6vHHEqWSgN0bPXaM= github.com/imfing/hextra v0.9.7/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI= github.com/imfing/hextra v0.11.1 h1:8pTc4ReYbzGTHAnyiebmlT3ijFfIXiGu1r7tM/UGjFI= github.com/imfing/hextra v0.11.1/go.mod h1:cEfel3lU/bSx7lTE/+uuR4GJaphyOyiwNR3PTqFTXpI= +github.com/imfing/hextra v0.12.0 h1:f6y35hW/WDJEcx9S0dOmbICOBxYE0PmP6IJFsTUgVyY= +github.com/imfing/hextra v0.12.0/go.mod h1:YAv8XRNSmcqjieFwI7fVQK1AoY2Do+45DO9HGqxSGu4= diff --git a/docs/hugo.toml b/docs/hugo.toml index 85bfd44d..d1b51de7 100644 --- a/docs/hugo.toml +++ b/docs/hugo.toml @@ -12,29 +12,48 @@ canonifyURLs = true path = "github.com/imfing/hextra" [[menu.main]] -name = "Developer Documentation" -pageRef = "/dev" +identifier = "userguide" +name = "User Guides" +pageRef = "/userguide" weight = 1 [[menu.main]] -name = "User Guides" -pageRef = "/userguide" +identifier = "documentation" +name = "Developer Documentation" weight = 2 [[menu.main]] +identifier = "contribution-guides" name = "Contribution Guides" pageRef = "CONTRIBUTING.md" +weight = 1 +parent = "documentation" + +[[menu.main]] +identifier = "developer-documentation" +name = "Developer Docs" +pageRef = "/dev" +weight = 2 +parent = "documentation" + +[[menu.main]] +identifier = "help" +name = "Help" weight = 3 [[menu.main]] +identifier = "faq" name = "FAQ" pageRef = "faq.md" -weight = 4 +weight = 1 +parent = "help" [[menu.main]] +identifier = "known-issues" name = "Known Issues" pageRef = "KnownIssues.md" -weight = 4 +weight = 2 +parent = "help" [[menu.main]] name = "Store" diff --git a/docs/i18n/en.yaml b/docs/i18n/en.yaml index ba84014d..8ea7eea2 100644 --- a/docs/i18n/en.yaml +++ b/docs/i18n/en.yaml @@ -1,5 +1,4 @@ copyright: "©  Chris Titus Tech. All rights reserved." - backToTop: "Scroll to top" changeLanguage: "Change language" changeTheme: "Change theme"