From 2a5d3dd63be62ebf4b2137cd0b0dea62d02a9a41 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Fri, 8 Nov 2024 14:48:29 -0600 Subject: [PATCH] Update powershell-style-guide.md Restoring numbered link references --- .../community/contributing/powershell-style-guide.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/reference/docs-conceptual/community/contributing/powershell-style-guide.md b/reference/docs-conceptual/community/contributing/powershell-style-guide.md index dec8fcef5f23..7e3f68195cae 100644 --- a/reference/docs-conceptual/community/contributing/powershell-style-guide.md +++ b/reference/docs-conceptual/community/contributing/powershell-style-guide.md @@ -251,11 +251,12 @@ example, even if the parameter is positional. This reduces the chance of confusi ## Formatting cmdlet reference articles -Cmdlet reference articles have a specific structure. This structure is defined by [PlatyPS][]. +Cmdlet reference articles have a specific structure. This structure is defined by [PlatyPS][07]. PlatyPS generates the cmdlet help for PowerShell modules in Markdown. After editing the Markdown files, PlatyPS is used create the MAML help files used by the `Get-Help` cmdlet. -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 +PlatyPS has a schema that expects a specific structure for cmdlet reference. The PlatyPS +[schema document][08] describes this structure. Schema violations cause build errors that must be fixed before we can accept your contribution. - Don't remove any of the ATX header structures. PlatyPS expects a specific set of headers in a @@ -336,7 +337,7 @@ Basic formatting guidelines: [04]: #markdown-for-code-samples [05]: editorial-checklist.md [06]: https://en.wikipedia.org/wiki/PascalCase -[PlatyPS]: https://github.com/powershell/platyps -[PlatyPS schema document]: https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md +[07]: https://github.com/powershell/platyps +[08]: https://github.com/PowerShell/platyPS/blob/master/docs/developer/platyPS/platyPS.schema.md [09]: https://pandoc.org [10]: overview.md#get-started-writing-docs