Commit c014177
authored
📖 [Docs]: README pages now use the standard module landing-page format (#15)
README pages now act as concise landing pages. Implemented modules point
users to installation, psmodule.io, and PowerShell help instead of
duplicating command reference content. Placeholder and in-progress
modules now state their status clearly so users are not shown scaffold
examples as working usage.
## Changed: README pages defer to generated documentation
Implemented module READMEs now provide a short overview, installation
commands, and links to generated documentation. Command usage remains in
PowerShell help and generated docs.
```powershell
Get-Command -Module <ModuleName>
Get-Help -Name 'CommandName' -Examples
```
## Changed: Placeholder modules identify their status
Repositories that still contain scaffold or stub module code now say
they are placeholders or in progress instead of showing template
commands as if they worked.
## Technical Details
- Updates `README.md` only.
- Aligns repository READMEs with the default introduced in
`PSModule/Template-PSModule`.
- Keeps command-level details out of README pages to avoid duplicating
generated module documentation.1 parent 7633950 commit c014177
1 file changed
Lines changed: 5 additions & 59 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | | - | |
| 5 | + | |
6 | 6 | | |
7 | | - | |
8 | | - | |
9 | | - | |
10 | | - | |
11 | | - | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
18 | | - | |
19 | | - | |
20 | | - | |
21 | | - | |
22 | | - | |
23 | | - | |
24 | | - | |
25 | | - | |
26 | | - | |
27 | | - | |
28 | | - | |
29 | | - | |
30 | | - | |
31 | | - | |
32 | | - | |
33 | | - | |
34 | | - | |
35 | | - | |
36 | | - | |
37 | | - | |
38 | | - | |
39 | | - | |
40 | | - | |
41 | | - | |
42 | | - | |
43 | | - | |
44 | | - | |
45 | | - | |
| 7 | + | |
46 | 8 | | |
47 | 9 | | |
48 | 10 | | |
49 | | - | |
50 | | - | |
| 11 | + | |
51 | 12 | | |
52 | 13 | | |
53 | 14 | | |
54 | | - | |
55 | | - | |
56 | | - | |
57 | | - | |
58 | | - | |
59 | | - | |
60 | | - | |
61 | | - | |
62 | | - | |
63 | | - | |
64 | | - | |
65 | | - | |
66 | | - | |
67 | | - | |
68 | | - | |
69 | | - | |
| 15 | + | |
0 commit comments