diff --git a/reference/docs-conceptual/community/2025-updates.md b/reference/docs-conceptual/community/2025-updates.md index dbd3cc4d60a..7ea36460e41 100644 --- a/reference/docs-conceptual/community/2025-updates.md +++ b/reference/docs-conceptual/community/2025-updates.md @@ -14,6 +14,34 @@ get started. [01]: contributing/overview.md +## 2025-September + +Content updates + +- Update release notes for PowerShell v7.5.3 and v7.4.12 releases +- Update release notes for PSReadLine v2.4.4-beta4 +- Improved the documentation for comment-based help and creating `about_*` topics + +GitHub stats + +- 21 PRs merged (6 from Community) +- 28 issues opened (25 from Community) +- 31 issues closed (28 Community issues closed) + +Top Community Contributors + +The following people contributed to PowerShell docs this month by submitting pull requests or +filing issues. Thank you! + +| GitHub Id | PRs merged | Issues opened | +| -------------- | :--------: | :-----------: | +| skycommand | 2 | | +| lukebarone | 1 | | +| PraveenGururaj | 1 | | +| Blake-Madden | 1 | | +| Gijsreyn | 1 | | +| TMA-2 | 1 | 1 | + ## 2025-August Content updates @@ -33,13 +61,11 @@ Top Community Contributors The following people contributed to PowerShell docs this month by submitting pull requests or filing issues. Thank you! -| GitHub Id | PRs merged | Issues opened | -| ----------- | :--------: | :-----------: | -| changeworld | 3 | | -| sethvs | 2 | | -| yashanshh | 2 | | -| Gijsreyn | 2 | | -| TNGBBK | | 2 | +| GitHub Id | PRs merged | Issues opened | +| --------------- | :--------: | :-----------: | +| changeworld | 2 | | +| Dickson-Mwendia | 1 | | +| chwarr | 1 | | ## 2025-July diff --git a/reference/docs-conceptual/community/hall-of-fame.md b/reference/docs-conceptual/community/hall-of-fame.md index b51d2a12f1c..7059f56ead4 100644 --- a/reference/docs-conceptual/community/hall-of-fame.md +++ b/reference/docs-conceptual/community/hall-of-fame.md @@ -1,6 +1,6 @@ --- description: List of the GitHub users that have the most contributions to the PowerShell-Doc project. -ms.date: 09/02/2025 +ms.date: 10/01/2025 title: Community contributor Hall of Fame --- # Community Contributor Hall of Fame @@ -17,7 +17,7 @@ Pull Requests help us fix those issues and make the documentation better for eve | PRs Merged | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | Grand Total | | ------------------ | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ----------: | -| Community | 3 | 194 | 446 | 467 | 321 | 160 | 99 | 121 | 108 | 81 | 132 | 2132 | +| Community | 3 | 194 | 446 | 467 | 321 | 160 | 99 | 121 | 108 | 81 | 138 | 2138 | | matt9ucci | | | 157 | 80 | 30 | 1 | 6 | | | | | 274 | | nschonni | | | | 14 | 138 | 10 | | | | | | 162 | | kiazhi | | 25 | 79 | 12 | | | | | | | | 116 | @@ -29,7 +29,7 @@ Pull Requests help us fix those issues and make the documentation better for eve | ArieHein | | | | | 1 | | | | | 7 | 25 | 33 | | yecril71pl | | | | | | 21 | 3 | 3 | | | | 27 | | changeworld | | | | | | | | 3 | | | 22 | 25 | -| skycommand | | | 1 | 3 | 3 | 6 | | 1 | 4 | 1 | 2 | 21 | +| skycommand | | | 1 | 3 | 3 | 6 | | 1 | 4 | 1 | 4 | 23 | | Dan1el42 | | 20 | | | | | | | | | | 20 | | NReilingh | | 2 | | 13 | 3 | | | | | | | 18 | | it-praktyk | | | | 16 | 1 | | | | | | | 17 | @@ -48,7 +48,7 @@ GitHub issues help us identify errors and gaps in our documentation. | Issues Opened | 2015 | 2016 | 2017 | 2018 | 2019 | 2020 | 2021 | 2022 | 2023 | 2024 | 2025 | Grand Total | | ------------------ | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ---: | ----------: | -| Community | 3 | 54 | 95 | 210 | 562 | 557 | 363 | 225 | 270 | 220 | 114 | 2673 | +| Community | 3 | 54 | 95 | 210 | 562 | 557 | 363 | 225 | 270 | 220 | 117 | 2676 | | mklement0 | | | 19 | 60 | 56 | 61 | 28 | 8 | 20 | 24 | 2 | 278 | | ehmiiz | | | | | | | | 20 | 14 | | | 34 | | iSazonov | | | 1 | 4 | 10 | 8 | 4 | 3 | | 1 | | 31 | diff --git a/reference/docs-conceptual/developer/help/writing-help-for-windows-powershell-modules.md b/reference/docs-conceptual/developer/help/writing-help-for-windows-powershell-modules.md index 8a825f73b47..2d7ddc6b7bc 100644 --- a/reference/docs-conceptual/developer/help/writing-help-for-windows-powershell-modules.md +++ b/reference/docs-conceptual/developer/help/writing-help-for-windows-powershell-modules.md @@ -1,6 +1,6 @@ --- description: Writing Help for PowerShell Modules -ms.date: 09/22/2025 +ms.date: 10/01/2025 title: Writing Help for PowerShell Modules --- # Writing Help for PowerShell Modules @@ -33,48 +33,64 @@ A module can include the following types of Help. You can use a conceptual ("about") Help topic to describe the module and its members and to explain how the members can be used together to perform tasks. By default, PowerShell includes - over 100 of these conceptual About Help topics. - - - Conceptual Help topics are text files with UTF-8 with BOM encoding. - - The filename must use the `about_.help.txt` format, such as `about_MyModule.help.txt`. - - For best display results, you should limit the length of each line to 80 characters. - - You can use the following sample template as a starting point for writing conceptual Help - topics. - - > [!NOTE] - > The `TOPIC` section header must start in the first column of the first line of the file. The - > section content on the second line should match the filename, without the `.help.txt` suffix. - > You must indent the content exactly 5 spaces. The third line must be blank. The - > `SHORT DESCRIPTION` section header must start in the first column of the fourth line. You must - > indent the content on the fifth line exactly 5 spaces. These requirements are necessary for - > the `Get-Help` cmdlet to recognize the content correctly. - - ``` - TOPIC - about_ - - SHORT DESCRIPTION - A short, one-line description of the topic contents. - - LONG DESCRIPTION - A detailed, full description of the subject or purpose of the module. - - EXAMPLES - Examples of how to use the module or how the subject feature works in - practice. - - KEYWORDS - Terms or titles on which you might expect your users to search for the - information in this topic. - - SEE ALSO - Text-only references for further reading. Hyperlinks can't work in the - PowerShell console. - ``` - - Except for the first two sections, the structure of conceptual Help topics is arbitrary. The - remaining section titles can be whatever is appropriate for your content. By convention, you - should use the same capitalization, indentation, and blank line separations. + over 100 of these conceptual About Help topics. The filename must use the `about_.help.txt` + format, such as `about_MyModule.help.txt`. + + > [!NOTE] + > The `TOPIC` section header must start in the first column of the first line of the file. The + > section content on the second line should match the filename, without the `.help.txt` suffix. + > You must indent the content exactly 4 spaces. The third line must be blank. The `SYNOPSIS` + > section header must start in the first column of the fourth line. You must indent the content + > on the fifth line exactly 4 spaces. These requirements are necessary for the `Get-Help` cmdlet + > to recognize the content correctly. + + ``` + TOPIC + about_ + + SYNOPSIS + A short, one-line description of the topic contents. + ``` + + You can use the following sample template as a starting point for writing conceptual Help topics. + Except for the first two sections, the structure of conceptual Help topics is arbitrary. The + remaining section titles can be whatever is appropriate for your content. + + ``` + TOPIC + about_ + + SYNOPSIS + A short, one-line description of the topic contents. + + LONG DESCRIPTION + + A detailed, full description of the subject or purpose of the module. + + EXAMPLES + + Examples of how to use the module or how the subject feature works in + practice. + + TROUBLESHOOTING + + Instructions for resolving common problems. + + SEE ALSO + + Text-only references for further reading. Hyperlinks can't work in the + PowerShell console. + ``` + + You can use any style and markup you want, but PowerShell sees it as plain text and there is no + special rendering of the text in the PowerShell console. The following suggestions ensure the best + display results and readability. + + - Use UTF-8 with BOM encoding to ensure any special (multi-byte) characters display correctly. + - Underline section headers or use all uppercase letters to make they stand out. This makes the + content easier to scan. + - Limit the length of each line to 80 characters. + - Indent code blocks and example output to separate them from the surrounding prose. ## Placement of Module Help