Rename folder Docs to docs

docs/check-file-system.md

@@ -0,0 +1,78 @@
+*check-file-system.ps1*
+================
+
+This PowerShell script checks the file system of a drive. It needs admin rights.
+
+Parameters
+----------
+```powershell
+PS> ./check-file-system.ps1 [[-Drive] <String>] [<CommonParameters>]
+
+-Drive <String>
+    Specifies the drive to check
+    
+    Required?                    false
+    Position?                    1
+    Default value                
+    Accept pipeline input?       false
+    Accept wildcard characters?  false
+
+[<CommonParameters>]
+    This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, 
+    WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
+```
+
+Example
+-------
+```powershell
+PS> ./check-file-system C
+✔️ file system on drive C is clean
+
+```
+
+Notes
+-----
+Author: Markus Fleschutz | License: CC0
+
+Related Links
+-------------
+https://github.com/fleschutz/PowerShell
+
+Script Content
+--------------
+```powershell
+<#
+.SYNOPSIS
+	Checks the file system of a drive (needs admin rights)
+.DESCRIPTION
+	This PowerShell script checks the file system of a drive. It needs admin rights.
+.PARAMETER Drive
+	Specifies the drive to check
+.EXAMPLE
+	PS> ./check-file-system C
+	✔️ file system on drive C is clean
+.LINK
+	https://github.com/fleschutz/PowerShell
+.NOTES
+	Author: Markus Fleschutz | License: CC0
+#>
+
+#Requires -RunAsAdministrator
+
+param([string]$Drive = "")
+
+try {
+	if ($Drive -eq "" ) { $Drive = read-host "Enter drive (letter) to check" }
+
+	$Result = repair-volume -driveLetter $Drive -scan
+	if ($Result -ne "NoErrorsFound") { throw "'repair-volume' failed" }
+
+	& "$PSScriptRoot/speak-english.ps1" "File system on drive $Drive is clean."
+	exit 0 # success
+} catch {
+	"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
+	exit 1
+}
+```
+
+*(generated by convert-ps2md.ps1 using the comment-based help of check-file-system.ps1 as of 10/19/2023 08:11:35)*