Skip to content

Preserve unique content in the README default#61

Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
docs/readme-content-standard
Open

Preserve unique content in the README default#61
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
mainfrom
docs/readme-content-standard

Conversation

@MariusStorhaug

@MariusStorhaug Marius Storhaug (MariusStorhaug) commented Jul 9, 2026

Copy link
Copy Markdown
Member

What

Updates the module README default in PowerShell/Modules/Repository-Defaults.md so that standardizing a README does not delete unique information.

The README is published as the module's landing page on the docs site (for example psmodule.io/<ModuleName>); the per-command reference is generated separately from comment-based help. So the README is often the only published home for prerequisites, platform/dependency notes, authentication and setup guidance, operational behavior (caching, state, update/versioning), and upstream attribution. Deleting it to shorten the README removes it from the site entirely.

Changes to the standard

  • Content preservation (keep / trim / relocate, never drop). Preserve unique content; only remove what is genuinely duplicated by the generated command reference.
  • Publishing model made explicit. The README publishes as the landing page. Content may move out of the README only into another published home — a command group's overview page under src/functions/public/<Group>/<Group>.md, or comment-based help. A bare top-level docs/ folder is not published, so moving content there drops it from the site. A longer README is acceptable for feature-rich modules; do not shorten by deleting.
  • Capabilities showcase is mandatory for implemented modules.
  • Upstream attribution exception. Credit, acknowledgements, donation notes, and third-party license notices are retained.
  • Fixed the copy/paste-hostile help example and extended README validation.

Gauge

Applied on two content-rich repos so the resulting READMEs can be used to judge the definition:

Follow-up: apply the definition to the remaining standardization PRs, and sync Template-PSModule's README.

Trimming a module README must not delete unique information. Adds a content-preservation rule (keep/trim/relocate, never drop), makes the capabilities showcase mandatory for implemented modules, carves out an upstream attribution and licensing exception, fixes the copy/paste-hostile Get-Help example, and extends README validation.
@github-actions

github-actions Bot commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

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

The README publishes as the module landing page; a bare top-level docs/ is not published by the docs build. Correct the relocation guidance to only published homes (README, group overview pages under src/functions/public, comment-based help) and state that a longer README is acceptable rather than deleting narrative content to shorten it.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant