Updating documentation (Pre v0.5.8) (#15)

This is a PR to prepare for an upcoming v0.5.8 release.

- Additional documentation for Intune setup.
- Updated dependabot config to use latest actions/checkout version.

Author: Stensel8

.github/dependabot.yml

@@ -12,9 +12,7 @@ updates:
       interval: "weekly"
       day: "monday"
       time: "09:00"
-    labels:
-      - "dependencies"
-      - "github-actions"
+    # No labels configured so Dependabot won't fail if these labels don't exist in the repo
     open-pull-requests-limit: 5
     commit-message:
       prefix: "chore(deps)"

.github/workflows/devskim.yml

@@ -23,7 +23,7 @@ jobs:
       security-events: write
     steps:
       - name: Checkout code
-        uses: actions/checkout@v5
+        uses: actions/checkout@v6
 
       - name: Run DevSkim scanner
         uses: microsoft/DevSkim-Action@v1

.github/workflows/powershell.yml

@@ -29,7 +29,7 @@ jobs:
     name: PSScriptAnalyzer
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
 
       - name: Run PSScriptAnalyzer
         uses: microsoft/psscriptanalyzer-action@6b2948b1944407914a58661c49941824d149734f

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ---
 
+## [0.5.8] - 2025-11-25
+
+### Added
+- Additional documentation for Intune setup.
+
+### Changed
+- Updated dependabot config to use latest actions/checkout version.
+
 ## [0.5.7] - 2025-11-21
 
 ### Added

Docs/Intune-Autopilot-Setup.md

@@ -88,8 +88,7 @@ Before creating Device Preparation Policies, ensure you have set up any required
 
    Example image: ![Intune scripts](./Intune%20configuration/Intune-scripts.png)
 
-**Note on OOBE Script**: For customizing the Out-of-Box Experience (OOBE), refer to the [Skip-OOBEPrivacy-Intune.ps1](./Scripts/Intune/Platform%20scripts/Skip-OOBEPrivacy-Intune.ps1) script. This can be added to Device Preparation Policies to skip privacy questions and accelerate provisioning.
-
+**Note on OOBE Script**: For customizing the Out-of-Box Experience (OOBE), refer to the [Skip-OOBEPrivacy-Intune.ps1](../Scripts/Intune/Platform%20scripts/Skip-OOBEPrivacy-Intune.ps1) script. This can be added to Device Preparation Policies to skip privacy questions and accelerate provisioning.
 
 ### 7. Configure MDM Enrollment for User Groups
 1. Go to the Microsoft Intune admin center at [https://intune.microsoft.com](https://intune.microsoft.com).
@@ -180,3 +179,4 @@ Finally, ensure users are added to the appropriate groups created earlier. This
 - If the "Intune Provisioning Client" is not found, ensure Intune is properly set up in your tenant and that you have the necessary licenses.
 - Verify group configurations in the Microsoft Entra portal.
 - For permission issues, contact your Microsoft Entra administrator.
+

autounattend.xml Docs/autounattend.xmlautounattend.xml renamed to Docs/autounattend.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <unattend xmlns="urn:schemas-microsoft-com:unattend" xmlns:wcm="http://schemas.microsoft.com/WMIConfig/2002/State">
-	<!--https://schneegans.de/windows/unattend-generator/?LanguageMode=Unattended&UILanguage=nl-NL&Locale=nl-NL&Keyboard=00020409&GeoLocation=176&ProcessorArchitecture=amd64&ProcessorArchitecture=arm64&HidePowerShellWindows=true&ComputerNameMode=Script&ComputerNameScript=%23+Get+the+serialnumber+of+the+machine+via+the+CIMinstance+cmdlet%0D%0A%24serial+%3D+%28Get-CimInstance+Win32_BIOS%29.SerialNumber%0D%0A%0D%0A%23+Format+the+serialnumber+to+give+back+the+last+5+characters+prefixed+with+%27PC-%27%0D%0Areturn+%27PC-%7B0%7D%27+-f+%24serial.Substring%28%24serial.Length+-+5%29%0D%0A&CompactOsMode=Default&TimeZoneMode=Explicit&TimeZone=W.+Europe+Standard+Time&PartitionMode=Interactive&DiskAssertionMode=Skip&WindowsEditionMode=Generic&WindowsEdition=pro&InstallFromMode=Automatic&PEMode=Default&UserAccountMode=Unattended&AccountName0=DenkoAdmin&AccountDisplayName0=&AccountPassword0=&AccountGroup0=Administrators&AutoLogonMode=Own&PasswordExpirationMode=Unlimited&LockoutMode=Default&HideFiles=Hidden&ShowFileExtensions=true&LaunchToThisPC=true&ShowEndTask=true&TaskbarSearch=Label&TaskbarIconsMode=Default&DisableWidgets=true&DisableBingResults=true&StartTilesMode=Default&StartPinsMode=Default&EnableLongPaths=true&DisableLastAccess=true&HideEdgeFre=true&DisableEdgeStartupBoost=true&DeleteWindowsOld=true&EffectsMode=Default&DesktopIconsMode=Custom&IconRecycleBin=true&IconThisPC=true&StartFoldersMode=Custom&StartFolderSettings=true&WifiMode=Skip&ExpressSettings=DisableAll&LockKeysMode=Configure&CapsLockInitial=Off&CapsLockBehavior=Toggle&NumLockInitial=On&NumLockBehavior=Toggle&ScrollLockInitial=Off&ScrollLockBehavior=Toggle&StickyKeysMode=Disabled&ColorMode=Custom&SystemColorTheme=Dark&AppsColorTheme=Dark&AccentColor=%230078d4&WallpaperMode=Default&LockScreenMode=Default&Remove3DViewer=true&RemoveBingSearch=true&RemoveClipchamp=true&RemoveCopilot=true&RemoveCortana=true&RemoveDevHome=true&RemoveFamily=true&RemoveFeedbackHub=true&RemoveGameAssist=true&RemoveInternetExplorer=true&RemoveMailCalendar=true&RemoveMaps=true&RemoveMediaFeatures=true&RemoveMixedReality=true&RemoveZuneVideo=true&RemoveNews=true&RemoveOffice365=true&RemoveOneNote=true&RemoveOneSync=true&RemoveOutlook=true&RemovePaint3D=true&RemovePeople=true&RemovePowerShell2=true&RemovePowerShellISE=true&RemoveRecall=true&RemoveSkype=true&RemoveSolitaire=true&RemoveStepsRecorder=true&RemoveStickyNotes=true&RemoveGetStarted=true&RemoveToDo=true&RemoveVoiceRecorder=true&RemoveWallet=true&RemoveWeather=true&RemoveFaxAndScan=true&RemoveWindowsMediaPlayer=true&RemoveWordPad=true&RemoveXboxApps=true&RemoveYourPhone=true&FirstLogonScript0=Start-Process+powershell.exe+-ArgumentList+%22-NoExit+-ExecutionPolicy+Bypass+-Command+%60%22iex+%28irm+%28%27https%3A%2F%2Fraw.githubusercontent.com%2FStensel8%2FWinDeploy%2F%27+%2B+%28irm+%27https%3A%2F%2Fapi.github.com%2Frepos%2FStensel8%2FWinDeploy%2Freleases%2Flatest%27%29.tag_name+%2B+%27%2FScripts%2FStart.ps1%27%29%29%60%22%22+-Wait%0D%0A&FirstLogonScriptType0=Ps1&WdacMode=Skip-->
+	<!--https://schneegans.de/windows/unattend-generator/?LanguageMode=Unattended&UILanguage=nl-NL&Locale=nl-NL&Keyboard=00020409&GeoLocation=176&ProcessorArchitecture=amd64&ProcessorArchitecture=arm64&HidePowerShellWindows=true&ComputerNameMode=Script&ComputerNameScript=%23+Get+the+serialnumber+of+the+machine+via+the+CIMinstance+cmdlet%0D%0A%24serial+%3D+%28Get-CimInstance+Win32_BIOS%29.SerialNumber%0D%0A%0D%0A%23+Format+the+serialnumber+to+give+back+the+last+5+characters+prefixed+with+%27PC-%27%0D%0Areturn+%27PC-%7B0%7D%27+-f+%24serial.Substring%28%24serial.Length+-+5%29%0D%0A&CompactOsMode=Default&TimeZoneMode=Explicit&TimeZone=W.+Europe+Standard+Time&PartitionMode=Interactive&DiskAssertionMode=Skip&WindowsEditionMode=Generic&WindowsEdition=pro&InstallFromMode=Automatic&PEMode=Default&UserAccountMode=Unattended&AccountName0=DenkoAdmin&AccountDisplayName0=&AccountPassword0=&AccountGroup0=Administrators&AutoLogonMode=Own&PasswordExpirationMode=Unlimited&LockoutMode=Default&HideFiles=Hidden&ShowFileExtensions=true&LaunchToThisPC=true&ShowEndTask=true&TaskbarSearch=Label&TaskbarIconsMode=Default&DisableWidgets=true&DisableBingResults=true&StartTilesMode=Default&StartPinsMode=Default&EnableLongPaths=true&DeleteJunctions=true&DisableLastAccess=true&HideEdgeFre=true&DisableEdgeStartupBoost=true&DeleteWindowsOld=true&EffectsMode=Default&DesktopIconsMode=Custom&IconRecycleBin=true&IconThisPC=true&StartFoldersMode=Custom&StartFolderSettings=true&WifiMode=Skip&ExpressSettings=DisableAll&LockKeysMode=Configure&CapsLockInitial=Off&CapsLockBehavior=Toggle&NumLockInitial=On&NumLockBehavior=Toggle&ScrollLockInitial=Off&ScrollLockBehavior=Toggle&StickyKeysMode=Disabled&ColorMode=Custom&SystemColorTheme=Dark&AppsColorTheme=Dark&AccentColor=%230078d4&WallpaperMode=Default&LockScreenMode=Default&Remove3DViewer=true&RemoveBingSearch=true&RemoveClipchamp=true&RemoveCopilot=true&RemoveCortana=true&RemoveDevHome=true&RemoveFamily=true&RemoveFeedbackHub=true&RemoveGameAssist=true&RemoveInternetExplorer=true&RemoveMailCalendar=true&RemoveMaps=true&RemoveMediaFeatures=true&RemoveMixedReality=true&RemoveZuneVideo=true&RemoveNews=true&RemoveOffice365=true&RemoveOneNote=true&RemoveOneSync=true&RemoveOutlook=true&RemovePaint3D=true&RemovePeople=true&RemovePowerShell2=true&RemovePowerShellISE=true&RemoveRecall=true&RemoveSkype=true&RemoveSolitaire=true&RemoveStepsRecorder=true&RemoveStickyNotes=true&RemoveGetStarted=true&RemoveToDo=true&RemoveVoiceRecorder=true&RemoveWallet=true&RemoveWeather=true&RemoveFaxAndScan=true&RemoveWindowsMediaPlayer=true&RemoveWordPad=true&RemoveXboxApps=true&RemoveYourPhone=true&FirstLogonScript0=Start-Process+powershell.exe+-ArgumentList+%22-NoExit+-ExecutionPolicy+Bypass+-Command+%60%22iex+%28irm+%28%27https%3A%2F%2Fraw.githubusercontent.com%2FStensel8%2FWinDeploy%2F%27+%2B+%28irm+%27https%3A%2F%2Fapi.github.com%2Frepos%2FStensel8%2FWinDeploy%2Freleases%2Flatest%27%29.tag_name+%2B+%27%2FScripts%2FStart.ps1%27%29%29%60%22%22+-Wait%0D%0A&FirstLogonScriptType0=Ps1&WdacMode=Skip-->
 	<settings pass="offlineServicing"></settings>
 	<settings pass="windowsPE">
 		<component name="Microsoft-Windows-International-Core-WinPE" processorArchitecture="amd64" publicKeyToken="31bf3856ad364e35" language="neutral" versionScope="nonSxS">
@@ -543,6 +543,13 @@ $scripts = @(
 	{
 		Get-AppxPackage -Name 'Microsoft.Windows.Ai.Copilot.Provider' | Remove-AppxPackage;
 	};
+	{
+		@(
+		  Get-ChildItem -LiteralPath $env:USERPROFILE -Force -Recurse -Depth 2;
+		) | Where-Object -FilterScript {
+			$_.Attributes.HasFlag( [System.IO.FileAttributes]::ReparsePoint );
+		} | Remove-Item -Force -Recurse -Verbose;
+	};
 	{
 		Set-ItemProperty -LiteralPath 'Registry::HKCU\Software\Microsoft\Windows\CurrentVersion\Explorer\Advanced' -Name 'LaunchTo' -Type 'DWord' -Value 1;
 	};
@@ -677,6 +684,17 @@ $scripts = @(
 	{
 		Set-ItemProperty -LiteralPath 'Registry::HKLM\SOFTWARE\Microsoft\Windows NT\CurrentVersion\Winlogon' -Name 'AutoLogonCount' -Type 'DWord' -Force -Value 0;
 	};
+	{
+		@(
+			Get-ChildItem -LiteralPath 'C:\' -Force;
+			Get-ChildItem -LiteralPath 'C:\Users' -Force;
+			Get-ChildItem -LiteralPath 'C:\Users\Default' -Force -Recurse -Depth 2;
+			Get-ChildItem -LiteralPath 'C:\Users\Public' -Force -Recurse -Depth 2;
+			Get-ChildItem -LiteralPath 'C:\ProgramData' -Force;
+		) | Where-Object -FilterScript {
+			$_.Attributes.HasFlag( [System.IO.FileAttributes]::ReparsePoint );
+		} | Remove-Item -Force -Recurse -Verbose;
+	};
 	{
 		cmd.exe /c "rmdir C:\Windows.old";
 	};

README.md

@@ -14,13 +14,30 @@
 
 Zero-touch Windows deployment with automatic driver updates, application installation, bloatware removal, and system configuration. Deploy via USB, network, RMM agents, or AutoUnattend.xml.
 
-![Terminal showing begin of deployment](Docs/Deployment_Flow.png)
+## Deployment options
 
-![Terminal showing a short demo of the deployment process](Docs/WinDeploy-Demo.gif)
+Choose how you want to deploy WinDeploy — pick the path that fits your environment.
 
-![Terminal showing successful deployment](Docs/Deployment_Success.png)
+| Local (USB / One-liner) | Intune / Autopilot |
+|---|---|
+| Deploy locally via USB, [`autounattend.xml`](Docs/autounattend.xml), or [one-liner script](#quick-start). | Deploy via [Intune Autopilot](Docs/Intune-Autopilot-Setup.md), targeting usergroups. |
+| [![Get started - Local](https://img.shields.io/badge/Get%20started-Local-blue?style=for-the-badge)](#quick-start) | [![Get started - Intune](https://img.shields.io/badge/Get%20started-Intune-brightgreen?style=for-the-badge)](Docs/Intune-Autopilot-Setup.md) |
 
-![Clean Windows after successful deployment](Docs/Expected_Result.png)
+
+<details open>
+<summary>View deployment screenshots</summary>
+
+<br>
+
+| Deployment Start | Live Demo |
+|-----------------|-----------|
+| <img src="Docs/Deployment_Flow.png" alt="Deployment start" width="400" height="225"> | <img src="Docs/WinDeploy-Demo.gif" alt="Deployment demo" width="400" height="225"> |
+
+| Successful Completion | Expected Result |
+|----------------------|-----------------|
+| <img src="Docs/Deployment_Success.png" alt="Deployment success" width="400" height="225"> | <img src="Docs/Expected_Result.png" alt="Clean Windows" width="400" height="225"> |
+
+</details>
 
 
 ---
@@ -30,13 +47,12 @@ Zero-touch Windows deployment with automatic driver updates, application install
 **Prerequisites:** Windows 11 Pro 24H2+, PowerShell 7, internet connection
 
 ### Option 1: USB Deployment (Fresh installs)
-```powershell
-# 1. Create bootable Windows 11 USB
-# 2. Copy autounattend.xml to USB root
-# 3. (Optional) Copy RMM agent as Agent.exe to USB root
-# 4. Boot from USB with network connected. Make sure to keep the USB drive connected until deployment is complete.
-# 5. Wait - everything happens automatically
-```
+1. Create bootable Windows 11 USB
+2. Copy autounattend.xml to USB root
+3. (Optional) Copy RMM agent as Agent.exe to USB root
+4. Boot from USB with network connected. Make sure to keep the USB drive connected until deployment is complete.
+5. Wait - everything happens automatically
+
 
 ### Option 2: Direct Execution (Existing or fresh installs)
 ```powershell

VERSION

@@ -1 +1 @@
-v0.5.7
+v0.5.8