Skip to content

Commit df77116

Browse files
Allow README capability showcases
1 parent 0bc16f1 commit df77116

1 file changed

Lines changed: 18 additions & 4 deletions

File tree

src/docs/PowerShell/Modules/Repository-Defaults.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -168,7 +168,7 @@ Dependabot PRs still go through normal review. Automated dependency updates are
168168
169169
## README default
170170
171-
A module README is a landing page, not the command reference. It should help a user identify the module, install it, and find generated documentation.
171+
A module README is a landing page, not the command reference. It should help a user identify the module, install it, see what it can do, and then find generated documentation.
172172
173173
Module installation examples must use PSResourceGet:
174174
@@ -194,6 +194,17 @@ Install-PSResource -Name <ModuleName>
194194
Import-Module -Name <ModuleName>
195195
```
196196

197+
## Capabilities
198+
199+
Use this section as a short showcase. Show the most important things the module makes possible with one to three realistic examples.
200+
201+
The goal is discovery and marketing, not exhaustive command documentation. A reader should understand why the module exists and what kind of tasks it helps with.
202+
203+
```powershell
204+
# Replace this with a real example that demonstrates the module's value.
205+
Get-Command -Module <ModuleName>
206+
```
207+
197208
## Documentation
198209

199210
Documentation is published at [psmodule.io/<ModuleName>](https://psmodule.io/<ModuleName>/).
@@ -210,7 +221,9 @@ Get-Help -Name 'CommandName' -Examples
210221
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
211222
````
212223

213-
README pages should not duplicate generated command documentation. Do not add full command inventories, parameter tables, or long usage sections when those details are already produced from comment-based help.
224+
README pages may include a short capabilities or usage showcase before the documentation link. Keep that section focused on discovery and marketing: show representative outcomes, not every command, parameter, or edge case.
225+
226+
README pages should not duplicate generated command documentation. Do not add full command inventories, parameter tables, or long reference sections when those details are already produced from comment-based help.
214227

215228
## Placeholder and in-progress repositories
216229

@@ -249,21 +262,22 @@ Before opening a README-only PR, check that the README follows the default and d
249262
```powershell
250263
Select-String -Path README.md -SimpleMatch -Pattern 'Greet-Entity', 'PSModuleTemplate', 'YourModuleName'
251264
Select-String -Path README.md -SimpleMatch -Pattern '{{ NAME }}', '{{ DESCRIPTION }}'
252-
Select-String -Path README.md -Pattern '^## (Usage|Commands|Examples)$'
265+
Select-String -Path README.md -Pattern '^## Commands$'
253266
git diff --check -- README.md
254267
```
255268

256269
`Template-PSModule` is the exception: it intentionally keeps `{{ NAME }}` and `{{ DESCRIPTION }}` tokens because those are template inputs.
257270

258271
## Documentation ownership
259272

260-
Command details belong in comment-based help and generated documentation. The README points to those sources instead of re-stating them.
273+
Command details belong in comment-based help and generated documentation. The README can showcase capability, then points to those sources for reference detail.
261274

262275
Use these defaults:
263276

264277
- Command synopsis, parameters, examples, links, and outputs live in comment-based help.
265278
- Group overview pages live next to public command groups in `src/functions/public/<Group>/<Group>.md`.
266279
- Realistic end-to-end scenarios live in `examples/`.
280+
- README capability examples are short, representative, and user-facing.
267281
- README pages stay short and stable.
268282

269283
This keeps the repository landing page readable and prevents drift between README content, PowerShell help, and generated documentation.

0 commit comments

Comments
 (0)