Skip to content

Commit 6b84b41

Browse files
Document PowerShell guidance scripts
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
1 parent 33438a2 commit 6b84b41

3 files changed

Lines changed: 33 additions & 0 deletions

File tree

docs/content/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ Look up the framework's exact contracts and the module-development standards it
5757
| [Scenario matrix](reference/scenario-matrix.md) | Which jobs run for each trigger scenario. |
5858
| [Framework test IDs](reference/framework-test-ids.md) | The framework tests enforced on source code and on the built module. |
5959
| [Dependencies](reference/dependencies.md) | The actions, modules, and services the workflow composes. |
60+
| [PowerShell guidance scripts](reference/guidance-scripts.md) | Runnable reference scripts for common PowerShell implementation patterns. |
6061

6162
## Specification
6263

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: PowerShell guidance scripts
3+
description: Reference PowerShell scripts that demonstrate implementation patterns used by the PSModule framework.
4+
---
5+
6+
# PowerShell guidance scripts
7+
8+
The [guidance directory](https://github.com/PSModule/Process-PSModule/tree/main/guidance) contains runnable reference scripts for common PowerShell implementation patterns. They are framework learning assets, not Process-PSModule module source, so they are intentionally kept outside `src/` and are not included in a module manifest.
9+
10+
Run an individual script only when its scenario is suitable for the local environment. Several scripts create temporary files, make web requests, or measure execution time.
11+
12+
| Script | Focus |
13+
| --- | --- |
14+
| `Add-Array.ps1` | Array and generic list population |
15+
| `Add-HashTable.ps1` | Hashtable population styles |
16+
| `Add-String.ps1` | String construction approaches |
17+
| `Caller.ps1` | Caller discovery through the PowerShell call stack |
18+
| `ClassExtension.ps1` | Class inheritance and base-method invocation |
19+
| `Loops.ps1` | Loop and function-call overhead |
20+
| `Out-Null.ps1` | Discarding command output |
21+
| `PipelineExecution.ps1` | Pipeline parameter evaluation and lifecycle blocks |
22+
| `PSCallStack.ps1` | Nested-call stack inspection |
23+
| `PSCmdlet.ps1` | The `$PSCmdlet` variable at nested call levels |
24+
| `PSModuleTest.psm1` | Module-component import and exports |
25+
| `Read-File.ps1` | File-reading approaches |
26+
| `root.ps1` | Nested PSScriptAnalyzer binary-module loading |
27+
| `WebCalls.ps1` | Web-request protocol comparisons |
28+
29+
## Maintenance
30+
31+
The files were imported byte-for-byte from [`PSModule/docs/guidance`](https://github.com/PSModule/docs/tree/main/guidance). When that published set changes, import the complete current file from its Git blob into this directory and preserve its contents. Keep this index synchronized with the directory so users can discover every available script.

docs/zensical.toml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ nav = [
4747
{"Scenario matrix" = "reference/scenario-matrix.md"},
4848
{"Framework test IDs" = "reference/framework-test-ids.md"},
4949
{"Dependencies" = "reference/dependencies.md"},
50+
{"PowerShell guidance scripts" = "reference/guidance-scripts.md"},
5051
]},
5152
{"Specification" = [
5253
"specification/index.md",

0 commit comments

Comments
 (0)