🩹 [Patch]: Add Linter settings + fix documentation structure

.github/PSModule.yml

@@ -19,3 +19,14 @@ Test:
 # Build:
 #   Docs:
 #     Skip: true
+
+Linter:
+  env:
+    VALIDATE_BIOME_FORMAT: false
+    VALIDATE_BIOME_LINT: false
+    VALIDATE_GITHUB_ACTIONS_ZIZMOR: false
+    VALIDATE_JSCPD: false
+    VALIDATE_JSON_PRETTIER: false
+    VALIDATE_MARKDOWN_PRETTIER: false
+    VALIDATE_YAML_PRETTIER: false
+    VALIDATE_POWERSHELL: false

.github/linters/.markdown-lint.yml

@@ -8,19 +8,19 @@
 ###############
 # Rules by id #
 ###############
-MD004: false                  # Unordered list style
+MD004: false # Unordered list style
 MD007:
-  indent: 2                   # Unordered list indentation
+  indent: 2 # Unordered list indentation
 MD013:
-  line_length: 808            # Line length
-MD024: false                  # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
+  line_length: 808 # Line length
+MD024: false # no-duplicate-heading, INPUTS and OUTPUTS _can_ be the same item
 MD026:
-  punctuation: ".,;:!。，；:"  # List of not allowed
-MD029: false                  # Ordered list item prefix
-MD033: false                  # Allow inline HTML
-MD036: false                  # Emphasis used instead of a heading
+  punctuation: '.,;:!。，；:' # List of not allowed
+MD029: false # Ordered list item prefix
+MD033: false # Allow inline HTML
+MD036: false # Emphasis used instead of a heading
 
 #################
 # Rules by tags #
 #################
-blank_lines: false  # Error on blank lines
+blank_lines: false # Error on blank lines

src/classes/public/GitHubPermission.ps1

@@ -1,4 +1,4 @@
-class GitHubPermission : System.IEquatable[Object] {
+class GitHubPermission : System.IEquatable[Object] {
     # The programmatic name of the permission as returned by the GitHub API
     [string] $Name
 

src/functions/private/Actions/Import-GitHubEventData.ps1

@@ -9,7 +9,9 @@ function Import-GitHubEventData {
         Import data from the event that triggered the workflow.
 
         .EXAMPLE
+        ```powershell
         Import-GitHubEventData
+        ```
     #>
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
         'PSUseShouldProcessForStateChangingFunctions', '',

src/functions/private/Actions/Import-GitHubRunnerData.ps1

@@ -7,7 +7,9 @@
         Import data about the runner that is running the workflow.
 
         .EXAMPLE
+        ```powershell
         Import-GitHubRunnerData
+        ```
     #>
     [Diagnostics.CodeAnalysis.SuppressMessageAttribute(
         'PSUseShouldProcessForStateChangingFunctions', '',

src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByRepo.ps1

@@ -12,12 +12,16 @@
         `created`, `event`, `head_sha`, `status`.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo'
+        ```
 
         Lists all workflow runs for a repository.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubWorkflowRunByRepo -Owner 'owner' -Repository 'repo' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success'
+        ```
 
         Lists all workflow runs for a repository with the specified actor, branch, event, and status.
 

src/functions/private/Actions/Workflow Run/Get-GitHubWorkflowRunByWorkflow.ps1

@@ -13,12 +13,16 @@
         `created`, `event`, `head_sha`, `status`.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42'
+        ```
 
         Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat`.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubWorkflowRunByWorkflow -Owner 'octocat' -Repository 'Hello-World' -ID '42' -Actor 'octocat' -Branch 'main' -Event 'push' -Status 'success'
+        ```
 
         Gets all workflow runs for the workflow with the ID `42` in the repository `Hello-World` owned by `octocat` that were triggered by the user
         `octocat` on the branch `main` and have the status `success`.

src/functions/private/Apps/GitHub Apps/Add-GitHubKeyVaultJWTSignature.ps1

@@ -8,7 +8,9 @@
         The function supports authentication via Azure CLI or Az PowerShell module and returns the signed JWT as a secure string.
 
         .EXAMPLE
+        ```powershell
         Add-GitHubKeyVaultJWTSignature -UnsignedJWT 'header.payload' -KeyVaultKeyReference 'https://myvault.vault.azure.net/keys/mykey'
+        ```
 
         Output:
         ```powershell

src/functions/private/Apps/GitHub Apps/Add-GitHubLocalJWTSignature.ps1

@@ -8,7 +8,9 @@
         This function handles the RSA signing process and returns the complete signed JWT.
 
         .EXAMPLE
+        ```powershell
         Add-GitHubLocalJWTSignature -UnsignedJWT 'eyJ0eXAiOi...' -PrivateKey '--- BEGIN RSA PRIVATE KEY --- ... --- END RSA PRIVATE KEY ---'
+        ```
 
         Adds a signature to the unsigned JWT using the provided private key.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppAsAuthenticatedApp.ps1

@@ -13,7 +13,9 @@
         to access this endpoint.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppAsAuthenticatedApp
+        ```
 
         Get the authenticated app.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppBySlug.ps1

@@ -7,7 +7,9 @@
         Gets a single GitHub App using the app's slug.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppByName -AppSlug 'github-actions'
+        ```
 
         Gets the GitHub App with the slug 'github-actions'.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallableOrganization.ps1

@@ -11,7 +11,9 @@
         - enterprise_organization_installations: read
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppInstallableOrganization -Enterprise 'msx'
+        ```
 
         .OUTPUTS
         GitHubOrganization[]

src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppAsList.ps1

@@ -10,7 +10,9 @@
         to access this endpoint.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppInstallationForAuthenticatedAppAsList
+        ```
 
         List installations for the authenticated app.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForAuthenticatedAppByID.ps1

@@ -10,7 +10,9 @@
         to access this endpoint.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppInstallationForAuthenticatedAppByID -ID 123456
+        ```
 
         Get an installation for the authenticated app with the specified ID.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForEnterpriseOrganization.ps1

@@ -9,7 +9,9 @@
         The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (read) permission.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppInstallationForEnterpriseOrganization -Enterprise 'msx' -Organization 'github'
+        ```
 
         Gets all GitHub Apps in the organization `github` in the enterprise `msx`.
 

src/functions/private/Apps/GitHub Apps/Get-GitHubAppInstallationForOrganization.ps1

@@ -8,7 +8,9 @@
         You must be an organization owner with `admin:read` scope to use this endpoint.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubAppInstallationForOrganization -Organization 'github'
+        ```
 
         Gets all GitHub Apps in the organization `github`.
 

src/functions/private/Apps/GitHub Apps/Install-GitHubAppOnEnterpriseOrganization.ps1

@@ -9,7 +9,9 @@
         The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission.
 
         .EXAMPLE
+        ```powershell
         Install-GitHubAppOnEnterpriseOrganization -Enterprise 'msx' -Organization 'org' -ClientID '123456'
+        ```
     #>
     [OutputType([GitHubAppInstallation])]
     [CmdletBinding()]

src/functions/private/Apps/GitHub Apps/New-GitHubUnsignedJWT.ps1

@@ -9,7 +9,9 @@
         that can be passed to a signing function.
 
         .EXAMPLE
+        ```powershell
         New-GitHubUnsignedJWT -ClientId 'Iv987654321'
+        ```
 
         Creates an unsigned JWT for a GitHub App using the specified client ID.
 

src/functions/private/Apps/GitHub Apps/Test-GitHubJWTRefreshRequired.ps1

@@ -1,4 +1,4 @@
-function Test-GitHubJWTRefreshRequired {
+function Test-GitHubJWTRefreshRequired {
     <#
         .SYNOPSIS
         Test if the GitHub JWT should be refreshed.
@@ -7,7 +7,9 @@ function Test-GitHubJWTRefreshRequired {
         Test if the GitHub JWT should be refreshed. JWTs are refreshed when they have 150 seconds or less remaining before expiration.
 
         .EXAMPLE
+        ```powershell
         Test-GitHubJWTRefreshRequired -Context $Context
+        ```
 
         This will test if the GitHub JWT should be refreshed for the specified context.
 

src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppAsApp.ps1

@@ -1,4 +1,4 @@
-function Uninstall-GitHubAppAsApp {
+function Uninstall-GitHubAppAsApp {
     <#
         .SYNOPSIS
         Delete an installation for the authenticated app.
@@ -7,7 +7,9 @@ function Uninstall-GitHubAppAsApp {
         Deletes a GitHub App installation using the authenticated App context.
 
         .EXAMPLE
+        ```powershell
         Uninstall-GitHubAppAsApp -ID 123456 -Context $appContext
+        ```
 
         Deletes the installation with ID 123456 for the authenticated app.
 

src/functions/private/Apps/GitHub Apps/Uninstall-GitHubAppOnEnterpriseOrganization.ps1

@@ -9,7 +9,9 @@
         The authenticated GitHub App must be installed on the enterprise and be granted the Enterprise/organization_installations (write) permission.
 
         .EXAMPLE
+        ```powershell
         Uninstall-GitHubAppOnEnterpriseOrganization -Enterprise 'github' -Organization 'octokit' -ID '123456'
+        ```
 
         Uninstall the GitHub App with the installation ID `123456` from the organization `octokit` in the enterprise `github`.
 

src/functions/private/Apps/GitHub Apps/Update-GitHubAppJWT.ps1

@@ -8,17 +8,23 @@
         it will be refreshed. This function implements mutex-based locking to prevent concurrent refreshes.
 
         .EXAMPLE
+        ```powershell
         Update-GitHubAppJWT -Context $Context
+        ```
 
         Updates the JSON Web Token (JWT) for a GitHub App using the specified context.
 
         .EXAMPLE
+        ```powershell
         Update-GitHubAppJWT -Context $Context -PassThru
+        ```
 
         This will update the GitHub App JWT for the specified context and return the updated context.
 
         .EXAMPLE
+        ```powershell
         Update-GitHubAppJWT -Context $Context -Silent
+        ```
 
         This will update the GitHub App JWT for the specified context without displaying progress messages.
 

src/functions/private/Artifacts/Get-GitHubArtifactById.ps1

@@ -9,7 +9,9 @@
         The function returns a custom GitHubArtifact object containing metadata and download information for the artifact.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubArtifactById -Owner 'octocat' -Repository 'hello-world' -ID '123456'
+        ```
 
         Output:
         ```powershell

src/functions/private/Artifacts/Get-GitHubArtifactFromRepository.ps1

@@ -10,7 +10,9 @@
         By default, only the latest version of each artifact is returned unless -AllVersions is specified.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubArtifactFromRepository -Owner 'octocat' -Repository 'demo-repo' -AllVersions
+        ```
 
         Output:
         ```powershell

src/functions/private/Artifacts/Get-GitHubArtifactFromWorkflowRun.ps1

@@ -9,7 +9,9 @@
         The function can optionally filter artifacts by name or return only the latest version per artifact name.
 
         .EXAMPLE
+        ```powershell
         Get-GitHubArtifactFromWorkflowRun -Owner 'octocat' -Repository 'demo' -ID '123456789'
+        ```
 
         Output:
         ```powershell

src/functions/private/Auth/Cli/Connect-GithubCli.ps1

@@ -9,8 +9,10 @@
         If authentication fails, a warning is displayed, and `LASTEXITCODE` is reset to `0`.
 
         .EXAMPLE
+        ```powershell
         $context = Connect-GitHubAccount
         $context | Connect-GitHubCli
+        ```
 
         Output:
         ```powershell

src/functions/private/Auth/Context/Assert-GitHubContext.ps1

@@ -8,7 +8,9 @@
         If the context does not meet the requirements, an error is thrown.
 
         .EXAMPLE
+        ```powershell
         Assert-GitHubContext -Context 'github.com/Octocat' -AuthType 'App'
+        ```
     #>
     [OutputType([void])]
     [CmdletBinding()]

src/functions/private/Auth/Context/Remove-GitHubContext.ps1

@@ -9,12 +9,16 @@
         If the specified context(s) exist, they will be removed from the vault.
 
         .EXAMPLE
+        ```powershell
         Remove-Context
+        ```
 
         Removes all contexts from the vault.
 
         .EXAMPLE
+        ```powershell
         Remove-Context -ID 'MyContext'
+        ```
 
         Removes the context called 'MyContext' from the vault.
     #>

src/functions/private/Auth/Context/Resolve-GitHubContext.ps1

@@ -11,12 +11,16 @@
         If the context is a App, it will look at the available contexts and return the one that matches the scope of the command being run.
 
         .EXAMPLE
+        ```powershell
         $Context = Resolve-GitHubContext -Context 'github.com/Octocat'
+        ```
 
         This will resolve the context 'github.com/Octocat' into a GitHubContext object.
 
         .EXAMPLE
+        ```powershell
         $Context = Resolve-GitHubContext -Context $GitHubContext
+        ```
 
         This will return the GitHubContext object.
     #>

src/functions/private/Auth/Context/Resolve-GitHubContextSetting.ps1

@@ -9,7 +9,9 @@
         it will return the default value from the GitHub configuration. This is useful for resolving API-related settings dynamically.
 
         .EXAMPLE
+        ```powershell
         Resolve-GitHubContextSetting -Name 'Repository' -Value 'MyRepo'
+        ```
 
         Output:
         ```powershell
@@ -19,7 +21,9 @@
         Returns the provided value 'MyRepo' for the 'Repository' setting.
 
         .EXAMPLE
+        ```powershell
         Resolve-GitHubContextSetting -Name 'Repository' -Context $GitHubContext
+        ```
 
         Output:
         ```powershell
@@ -29,7 +33,9 @@
         Retrieves the 'Repository' setting from the provided GitHub context object.
 
         .EXAMPLE
+        ```powershell
         Resolve-GitHubContextSetting -Name 'ApiBaseUrl'
+        ```
 
         Output:
         ```powershell