Skip to content

Commit eb60daf

Browse files
Restructure products into top-level PowerShell and GitHub Actions sections
- PowerShell-Modules/ replaced by PowerShell/ with sub-sections: Modules, Scripts, DSC - Each sub-section has its own index and Standards page - PowerShell module standards moved from Agents/Standards/ to PowerShell/Modules/Standards.md - GitHub Actions standards moved from Agents/Standards/ to GitHub-Actions/Standards.md - Agents/Standards/index.md updated to link to canonical locations - GitHub Actions promoted to top-level nav entry (was nested under Projects) - Projects nav group removed - zensical.toml nav updated throughout
1 parent e9e8390 commit eb60daf

12 files changed

Lines changed: 67 additions & 21 deletions

File tree

docs/Agents/Standards/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ Per-language and per-platform standards referenced by the [Builder](https://gith
1010

1111
## Available standards
1212

13-
- **[PowerShell Modules](PowerShell-Module.md)** — module layout, naming, parameter design, style, tests.
14-
- **[GitHub Actions](GitHub-Actions.md)** — workflow security, SHA pinning, permissions, OIDC, the Zizmor checklist.
13+
- **[PowerShell Modules](../../PowerShell/Modules/Standards.md)** — module layout, naming, parameter design, style, tests.
14+
- **[GitHub Actions](../../GitHub-Actions/Standards.md)** — workflow security, SHA pinning, permissions, OIDC, the Zizmor checklist.
1515

1616
> More standards will be added as PSModule adopts more languages and platforms. Each new standard follows the same shape: principles → concrete rules → examples.
1717
File renamed without changes.

docs/PowerShell-Modules/index.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/PowerShell/DSC/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# DSC
2+
3+
PowerShell Desired State Configuration (DSC) resources for declarative system configuration.
4+
5+
> This section is coming soon. Standards and conventions for DSC resources will be documented here.
File renamed without changes.
File renamed without changes.

docs/PowerShell/Modules/index.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Modules
2+
3+
PSModule modules are reusable PowerShell libraries published to the PowerShell Gallery. They are built with the [PSModule framework](https://github.com/PSModule/PSModule) and follow a consistent layout, naming, and versioning convention.
4+
5+
## What's covered
6+
7+
- **[Standards](Standards.md)** — Repository layout, naming, style, parameter design, comment-based help, and SOLID applied to PowerShell modules.
8+
- **[Test Specification](Test-Specification.md)** — How we write Pester tests: structure, hierarchy, and naming conventions.
9+
- **[Versioning](Versioning.md)** — How changes to the public interface determine the SemVer version bump.
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# Script Standards
2+
3+
Standards for writing standalone PowerShell scripts in the PSModule ecosystem.
4+
5+
> This page is a stub. Standards will be documented here as conventions stabilise.
6+
7+
## General principles
8+
9+
- Scripts follow the same naming, style, and parameter conventions as module functions. See [Module Standards](../Modules/Standards.md) as the baseline.
10+
- Scripts that grow beyond a single responsibility should be promoted to module functions.
11+
- All scripts must run on PowerShell (cross-platform) — not Windows PowerShell 5.1.

docs/PowerShell/Scripts/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Scripts
2+
3+
Standalone PowerShell scripts used for automation, tooling, and developer workflows across the PSModule ecosystem.
4+
5+
## What's covered
6+
7+
- **[Standards](Standards.md)** — How we write, name, and structure PowerShell scripts.

0 commit comments

Comments
 (0)