From f1bea26fc67774f7b678dfa3185b98d423df4723 Mon Sep 17 00:00:00 2001 From: Mikey Lombardi Date: Thu, 1 Aug 2024 10:53:59 -0500 Subject: [PATCH 1/2] (MAINT) Clarify line length for about topics Prior to this change, the contributing guide indicated that the line length should be limited to 100 characters. It clarified that this guideline applies to conceptual articles and cmdlet reference, but didn't indicate that the line length in `about_` topics should be limited to 80 characters. This change clarifies the guidance. --- .../community/contributing/general-markdown.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/reference/docs-conceptual/community/contributing/general-markdown.md b/reference/docs-conceptual/community/contributing/general-markdown.md index 3cdb82f67ae4..14c366e3620b 100644 --- a/reference/docs-conceptual/community/contributing/general-markdown.md +++ b/reference/docs-conceptual/community/contributing/general-markdown.md @@ -1,6 +1,6 @@ --- description: This article provides specific guidance for using Markdown in our documentation. -ms.date: 04/23/2024 +ms.date: 08/01/2024 title: Markdown best practices --- # Markdown best practices @@ -50,9 +50,9 @@ Only use [ATX headings][07] (`#` style, as opposed to `=` or `-` style headers). ## Limit line length to 100 characters -This applies to conceptual articles and cmdlet reference. Limiting the line length improves the -readability of `git` diffs and history. It also makes it easier for other writers to make -contributions. +This applies to conceptual articles and cmdlet reference. For `about_` topics, limit the line +length to 80 characters. Limiting the line length improves the readability of `git` diffs and +history. It also makes it easier for other writers to make contributions. Use the [Reflow Markdown][09] extension in VS Code to reflow paragraphs to fit the prescribed line length. From 63fa3fe99f22677085eaa9152ddb9b7d1ccdb2d5 Mon Sep 17 00:00:00 2001 From: Sean Wheeler Date: Thu, 1 Aug 2024 10:57:48 -0500 Subject: [PATCH 2/2] Update reference/docs-conceptual/community/contributing/general-markdown.md --- .../docs-conceptual/community/contributing/general-markdown.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/docs-conceptual/community/contributing/general-markdown.md b/reference/docs-conceptual/community/contributing/general-markdown.md index 14c366e3620b..3b67603caa65 100644 --- a/reference/docs-conceptual/community/contributing/general-markdown.md +++ b/reference/docs-conceptual/community/contributing/general-markdown.md @@ -51,7 +51,7 @@ Only use [ATX headings][07] (`#` style, as opposed to `=` or `-` style headers). ## Limit line length to 100 characters This applies to conceptual articles and cmdlet reference. For `about_` topics, limit the line -length to 80 characters. Limiting the line length improves the readability of `git` diffs and +length to 79 characters. Limiting the line length improves the readability of `git` diffs and history. It also makes it easier for other writers to make contributions. Use the [Reflow Markdown][09] extension in VS Code to reflow paragraphs to fit the prescribed line