📖 [Docs]: PowerShell module repository defaults now documented

[Marius Storhaug (MariusStorhaug)]

PowerShell module repository defaults are now documented in the PSModule docs site. Module maintainers can use one central page to understand the expected repository metadata, layout, README shape, shared community files, supply-chain defaults, managed-file distribution model, documentation ownership, and release defaults.

⚠️ This PR has no linked issue. Consider creating one for traceability.

New: Repository defaults for module repositories

A new PowerShell module repository defaults page defines the baseline contract for PSModule module repositories. It explains what belongs in the README, when placeholder repositories should say they are placeholders, and where generated command documentation should live.

New: Required common files and managed-file ownership

The standard now defines required repository files such as README.md, LICENSE, CONTRIBUTING.md, SECURITY.md, SUPPORT.md, CODE_OF_CONDUCT.md, .github/dependabot.yml, .github/CODEOWNERS, linter settings, and PSModule settings. It also explains why repository-local files are needed even when organization-level .github community files exist, and points to Distributor as the preferred managed-file mechanism.

New: Supply-chain defaults use Dependabot

Module repositories are expected to include Dependabot configuration for GitHub Actions and PowerShell dependencies. This makes dependency maintenance and supply-chain review part of the default repository contract.

Changed: README pages are concise start pages

Implemented module READMEs should answer what the module is, why it matters, how to install it, how it works at a high level, and where generated documentation lives. The capabilities section is a short discovery showcase, not command reference duplication.

Changed: Product documentation belongs in generated docs or docs folders

PowerShell modules should keep detailed product documentation in generated command help and, when needed, a docs/ documentation surface published through GitHub Pages or the initiative's module documentation site.

Changed: Installation guidance uses PSResourceGet

New module repository documentation should use Install-PSResource. Install-Module is only retained for legacy or historical context where changing it would misrepresent the referenced system.

Technical Details

• Adds src/docs/PowerShell/Modules/Repository-Defaults.md.
• Adds the page to the Zensical navigation in src/zensical.toml.
• Adds a link from src/docs/PowerShell/Modules/index.md.
• Documents the current Distributor subscription model plus the desired global and mandatory file-set direction from PSModule/Distributor#4 and PSModule/Distributor#5.

[github-actions]

Super-linter summary

Language	Validation result
CHECKOV	Pass ✅
GITHUB_ACTIONS	Pass ✅
GITHUB_ACTIONS_ZIZMOR	Pass ✅
GITLEAKS	Pass ✅
GIT_MERGE_CONFLICT_MARKERS	Pass ✅
HTML	Pass ✅
JAVASCRIPT_ES	Pass ✅
JAVASCRIPT_PRETTIER	Pass ✅
MARKDOWN	Pass ✅
NATURAL_LANGUAGE	Pass ✅
POWERSHELL	Pass ✅
PRE_COMMIT	Pass ✅
SPELL_CODESPELL	Pass ✅
TRIVY	Pass ✅
YAML	Pass ✅

All files and directories linted successfully

For more information, see the GitHub Actions workflow run

Powered by Super-linter