Skip to content

Commit fafc5cd

Browse files
authored
powershell-style-guide.md: Update PlatyPS schema link
The old link broke.
1 parent 1bc513d commit fafc5cd

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

reference/docs-conceptual/community/contributing/powershell-style-guide.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -251,12 +251,11 @@ example, even if the parameter is positional. This reduces the chance of confusi
251251

252252
## Formatting cmdlet reference articles
253253

254-
Cmdlet reference articles have a specific structure. This structure is defined by [PlatyPS][07].
254+
Cmdlet reference articles have a specific structure. This structure is defined by [PlatyPS][].
255255
PlatyPS generates the cmdlet help for PowerShell modules in Markdown. After editing the Markdown
256256
files, PlatyPS is used create the MAML help files used by the `Get-Help` cmdlet.
257257

258-
PlatyPS has a schema that expects a specific structure for cmdlet reference. The PlatyPS
259-
[schema document][08] describes this structure. Schema violations cause build errors that must be
258+
PlatyPS has a schema that expects a specific structure for cmdlet reference. The [PlatyPS schema document][] describes this structure. Schema violations cause build errors that must be
260259
fixed before we can accept your contribution.
261260

262261
- Don't remove any of the ATX header structures. PlatyPS expects a specific set of headers in a
@@ -337,7 +336,7 @@ Basic formatting guidelines:
337336
[04]: #markdown-for-code-samples
338337
[05]: editorial-checklist.md
339338
[06]: https://en.wikipedia.org/wiki/PascalCase
340-
[07]: https://github.com/powershell/platyps
341-
[08]: https://github.com/PowerShell/platyPS/blob/master/platyPS.schema.md
339+
[PlatyPS]: https://github.com/powershell/platyps
340+
[PlatyPS schema document]: https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md
342341
[09]: https://pandoc.org
343342
[10]: overview.md#get-started-writing-docs

0 commit comments

Comments
 (0)