Preserve unique content in the README default#61
Open
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Open
Preserve unique content in the README default#61Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Marius Storhaug (MariusStorhaug) wants to merge 2 commits into
Conversation
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.
Contributor
Super-linter summary
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the module README default in
PowerShell/Modules/Repository-Defaults.mdso 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
src/functions/public/<Group>/<Group>.md, or comment-based help. A bare top-leveldocs/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.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.