You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/docs/PowerShell/Modules/Repository-Defaults.md
+18-4Lines changed: 18 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -168,7 +168,7 @@ Dependabot PRs still go through normal review. Automated dependency updates are
168
168
169
169
## README default
170
170
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.
172
172
173
173
Module installation examples must use PSResourceGet:
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
+
197
208
## Documentation
198
209
199
210
Documentation is published at [psmodule.io/<ModuleName>](https://psmodule.io/<ModuleName>/).
Issues and pull requests are welcome. Please use the repository issue tracker to report bugs, request features, or discuss improvements.
211
222
````
212
223
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.
214
227
215
228
## Placeholder and in-progress repositories
216
229
@@ -249,21 +262,22 @@ Before opening a README-only PR, check that the README follows the default and d
`Template-PSModule` is the exception: it intentionally keeps `{{ NAME }}` and `{{ DESCRIPTION }}` tokens because those are template inputs.
257
270
258
271
## Documentation ownership
259
272
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.
261
274
262
275
Use these defaults:
263
276
264
277
- Command synopsis, parameters, examples, links, and outputs live in comment-based help.
265
278
- Group overview pages live next to public command groups in `src/functions/public/<Group>/<Group>.md`.
266
279
- Realistic end-to-end scenarios live in `examples/`.
280
+
- README capability examples are short, representative, and user-facing.
267
281
- README pages stay short and stable.
268
282
269
283
This keeps the repository landing page readable and prevents drift between README content, PowerShell help, and generated documentation.
0 commit comments