refactor: re-write comments which were misleading

Author: jacksyrm

playbook/Configuration/atlas/appx.yml

@@ -18,8 +18,6 @@ actions:
   # deprovisioning, cache clearing) lives in the AppxSupport phase
   # (AtlasModules\Scripts\Phases\Invoke-AppxSupportPhase.ps1).
 
-  #####################################################################################################
-
   # Snapshot current AppX packages to deprovision removed ones afterward and
   # kill Teams processes
   - !powerShell:
@@ -34,9 +32,9 @@ actions:
   # (it must run as the user so Get-AppxPackage sees the user's packages).
   - !registryValue: {path: 'HKLM\SOFTWARE\Microsoft\Windows\CurrentVersion\Communications', value: 'ConfigureChatAutoInstall', data: '0', type: REG_DWORD}
 
-  # Microsoft Edge (moved from atlas\components.yml; the rest of the Edge removal
-  # runs in the Components phase, gated on the same option). Legacy EdgeHTML, the
-  # Chromium Edge AppX and the Game Assist companion.
+  # Microsoft Edge (the rest of the Edge removal runs in the Components phase,
+  # gated on the same option). Legacy EdgeHTML, the Chromium Edge AppX and the
+  # Game Assist companion.
   - !appx: {name: 'Microsoft.MicrosoftEdge_8wekyb3d8bbwe', type: family, option: 'uninstall-edge', ignoreErrors: true}
   - !appx: {name: 'Microsoft.MicrosoftEdge.Stable_8wekyb3d8bbwe', type: family, option: 'uninstall-edge', ignoreErrors: true}
   - !appx: {name: 'Microsoft.Edge.GameAssist*', type: family, option: 'uninstall-edge', ignoreErrors: true}

playbook/Configuration/atlas/components.yml

@@ -6,7 +6,7 @@ actions:
   # The component removal logic lives in the Components phase
   # (AtlasModules\Scripts\Phases\Invoke-ComponentsPhase.ps1): Security Center startup
   # item, Smart App Control, Microsoft Edge, OneDrive and the CBS component packages.
-  # Edge's !appx family removal moved to atlas\appx.yml (AME-only action).
+  # Edge's !appx family removal is in atlas\appx.yml (AME-only action).
 
   - !writeStatus: {status: 'Removing Microsoft Edge', option: 'uninstall-edge'}
 

playbook/Configuration/atlas/default.yml

@@ -11,8 +11,8 @@ actions:
     runas: currentUserElevated
   # Defaults phase (AtlasModules\Scripts\Phases\Invoke-DefaultsPhase.ps1): on upgrades,
   # re-applies every recorded toggle whose state is not 0 by re-running its recorded
-  # launcher silently (Invoke-AtlasToggleReapply, the DEFAULT.ps1 replacement). Fresh
-  # installs use the DEFAULT.reg import above.
+  # launcher silently (Invoke-AtlasToggleReapply). Fresh installs use the DEFAULT.reg
+  # import above.
   - !powerShell:
     command: '& (Join-Path ([Environment]::GetFolderPath(''Windows'')) ''AtlasModules\Scripts\Invoke-AtlasInstall.ps1'') -Phase Defaults'
     onUpgrade: true

playbook/Configuration/tweaks.yml

@@ -10,7 +10,7 @@ actions:
   # engine invocation; per-tweak order and enable/disable live in
   # Scripts\Tweaks\tweaks.manifest.psd1 (comment a line out to disable it).
   #
-  # Every tweak is now PowerShell - there are no !task includes. Per-user shell COM
+  # Every tweak is PowerShell - there are no !task includes. Per-user shell COM
   # (theme, lock-screen, pin-to-Home) is applied by Initialize-NewUser, never from
   # these SYSTEM-context phases: for the installing account it runs below with
   # -FromInstall (elevated user session), for new accounts at first logon via RunOnce.

playbook/Executables/AtlasModules/Scripts/Internal/Disable-FileSharing.ps1

@@ -8,7 +8,6 @@ Set-StrictMode -Version 3.0
 
 $fileSharingConfigPath = "$([Environment]::GetFolderPath('Windows'))\AtlasDesktop\3. General Configuration\File Sharing"
 
-# Disable network items
 Get-NetAdapterBinding -Name "*" -ComponentID ms_msclient, ms_server, ms_lltdio, ms_rspndr -ErrorAction SilentlyContinue |
     Disable-NetAdapterBinding -ErrorAction SilentlyContinue |
     Out-Null
@@ -23,10 +22,8 @@ foreach ($interface in $interfaces) {
 # Disable NetBIOS service
 Set-Service -Name NetBT -StartupType Disabled
 
-# Set network profile to 'Public Network'
 Get-NetConnectionProfile | Set-NetConnectionProfile -NetworkCategory Public
 
-# Disable network discovery firewall rules
 Get-NetFirewallRule | Where-Object {
     # File and Printer Sharing, Network Discovery
     (

playbook/Executables/AtlasModules/Scripts/Internal/Disable-PowerSaving.ps1

@@ -22,7 +22,6 @@ WARNING: You are on a laptop, disabling power saving will cause faster battery d
 This script will disable many power saving features in Windows for reduced latency and increased performance.
 Ensure that you have adequate cooling.`n
 "@ -ForegroundColor Cyan
-    #Pause
 }
 
 Write-Host "`nAdding power scheme..." -ForegroundColor Yellow
@@ -53,7 +52,6 @@ powercfg /setacvalueindex scheme_current 7516b95f-f776-4464-8c53-06167f40cc99 3c
 ## Processor performance time check interval - 200 milliseconds
 ## Reduces DPCs, can be set all the way to 5000ms for statically clocked systems
 powercfg /setacvalueindex scheme_current 54533251-82be-4824-96c1-47b60b740d00 4d2b0152-7d5c-498b-88e2-34345392a2c5 200
-# Set the active scheme as the current scheme
 powercfg /setactive scheme_current
 
 Write-Host "Disabling power-saving ACPI devices..." -ForegroundColor Yellow
@@ -77,7 +75,6 @@ foreach ($setting in @(
     # Wi-Fi capability that saves power consumption
     "uAPSDSupport",
 
-    # Self-explanatory
     "EnablePowerManagement",
     "EnableSavePowerNow",
     "bLowPowerEnable",
@@ -135,7 +132,4 @@ $powerKey = "HKLM:\SYSTEM\CurrentControlSet\Control\Power\PowerThrottling"
 if (!(Test-Path $powerKey)) { New-Item -Path $powerKey -Force | Out-Null }
 New-ItemProperty -Path $powerKey -Name "PowerThrottlingOff" -Value 1 -PropertyType DWORD -Force | Out-Null
 
-#if ($Silent) { exit }
-#Read-Pause "`nCompleted.`nPress Enter to exit"
-
 exit

playbook/Executables/AtlasModules/Scripts/Internal/Enable-FileSharing.ps1

@@ -5,7 +5,6 @@ Set-StrictMode -Version 3.0
 $networkDiscoveryConfigPath = "$([Environment]::GetFolderPath('Windows'))\AtlasDesktop\6. Advanced Configuration\Services\Network Discovery"
 $fileSharingConfigPath = "$([Environment]::GetFolderPath('Windows'))\AtlasDesktop\3. General Configuration\File Sharing"
 
-# Enable network items
 Enable-NetAdapterBinding -Name "*" -ComponentID ms_msclient, ms_server, ms_lltdio, ms_rspndr | Out-Null
 
 # Enable Network Discovery services and its dependencies
@@ -23,10 +22,8 @@ Set-Service -Name NetBT -StartupType System
 
 choice /c:yn /n /m "Would you like to change your network profile to 'Private'? [Y/N] "
 if ($LASTEXITCODE -eq 1) {
-    # Set network profile to 'Private Network'
     Get-NetConnectionProfile | Set-NetConnectionProfile -NetworkCategory Private
 
-    # Disable network discovery firewall rules
     Get-NetFirewallRule | Where-Object {
         # File and Printer Sharing, Network Discovery
         (

playbook/Executables/AtlasModules/Scripts/Internal/Install-Software.ps1

@@ -1,6 +1,6 @@
 # Thin forwarder kept for ScriptWrappers\Install-Software.ps1 ("Install Software" in the
 # Atlas folder); the WinGet picker UI lives in the Atlas.Software module
-# (Show-AtlasSoftwarePicker). Exits 1 when WinGet is unavailable, as before.
+# (Show-AtlasSoftwarePicker). Exits 1 when WinGet is unavailable.
 $ErrorActionPreference = 'Stop'
 
 Import-Module -Name (Join-Path -Path $PSScriptRoot -ChildPath '..\Modules\Atlas.Software\Atlas.Software.psd1')

playbook/Executables/AtlasModules/Scripts/Internal/Remove-Edge.ps1

@@ -116,7 +116,7 @@ function DeleteIfExist($Path) {
 
 function Remove-EdgePath {
     # Take ownership, grant Administrators full control, then delete - with a cmd 'rd'
-    # retry for trees the provider can't remove. Port of edge.py's remove_directory.
+    # retry for trees the provider can't remove.
     param([Parameter(Mandatory = $true)][string]$Path)
 
     if (-not (Test-Path -LiteralPath $Path)) {
@@ -131,7 +131,6 @@ function Remove-EdgePath {
     }
 }
 
-# True if it's installed
 function EdgeInstalled {
     foreach ($msedgeExe in $msedgeExePaths) {
         if (Test-Path $msedgeExe) {
@@ -226,8 +225,8 @@ function DisableEdgeUpdateInfrastructure {
 function Remove-EdgeRegistration {
     # Edge leaves shell registration behind after its binaries are gone: dead protocol
     # handlers (microsoft-edge:), App Paths\msedge.exe, a binary-less Apps-list Uninstall
-    # row, StartMenuInternet and EdgeUpdate\Clients. Port of edge.py's registry cleanup;
-    # each key is removed from both the 64- and 32-bit views. WebView2 keys are untouched.
+    # row, StartMenuInternet and EdgeUpdate\Clients. Each key is removed from both the
+    # 64- and 32-bit views. WebView2 keys are untouched.
     $edgeKeys = @(
         'HKLM\SOFTWARE\Microsoft\Edge'
         'HKLM\SOFTWARE\Microsoft\EdgeUpdate'
@@ -482,7 +481,7 @@ if ($UninstallEdge) {
     # Kick off Edge's own uninstaller detached and DO NOT wait for it. A synchronous
     # system-level --force-uninstall runs its RestartManager phase in the live session and
     # signs the user out on 24H2/25H2; launching it detached lets the direct file deletion
-    # below finish the removal first (port of edge.py: Popen + short sleep, then delete).
+    # below finish the removal first.
     foreach ($root in @(
             "$([Environment]::GetFolderPath('ProgramFilesx86'))\Microsoft\Edge\Application",
             "$([Environment]::GetFolderPath('ProgramFiles'))\Microsoft\Edge\Application"
@@ -514,7 +513,7 @@ if ($UninstallEdge) {
 
     # Remove leftover Edge shortcuts (they now point at deleted binaries and fail to open):
     # every user's Desktop, Quick Launch and taskbar pin, plus the Public Desktop and the
-    # common Start Menu. Port of edge.py's icon cleanup.
+    # common Start Menu.
     $edgeShortcutNames = @('edge.lnk', 'Microsoft Edge.lnk')
     $relativeShortcutDirs = @(
         'Desktop'

playbook/Executables/AtlasModules/Scripts/Internal/Set-DefaultPowerSaving.ps1

@@ -42,7 +42,6 @@ foreach ($value in @(
 Write-Host "Enabling network adapter power saving..." -ForegroundColor Yellow
 # Set power saving mode for all network cards to default
 Set-ItemProperty -Path 'HKLM:\SYSTEM\CurrentControlSet\Services\NDIS\Parameters' -Name "DefaultPnPCapabilities" -Value 0
-# Configure network adapter settings
 $properties = Get-NetAdapter -Physical | Get-NetAdapterAdvancedProperty
 foreach ($setting in @(
     # Stands for Ultra Low Power
@@ -58,7 +57,6 @@ foreach ($setting in @(
     # Wi-Fi capability that saves power consumption
     "uAPSDSupport",
 
-    # Self-explanatory
     "EnablePowerManagement",
     "EnableSavePowerNow",
     "bLowPowerEnable",
@@ -85,5 +83,4 @@ Remove-ItemProperty -Path "HKLM:\SYSTEM\CurrentControlSet\Control\Power\PowerThr
 
 
 if ($Silent) { exit }
-# Finish
 Read-Pause "`nCompleted.`nPress Enter to exit"