From ffae2d437cbb6c4e1b950c3e28767b125b0634fc Mon Sep 17 00:00:00 2001 From: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com> Date: Mon, 27 Apr 2026 16:38:56 -0400 Subject: [PATCH] style: use numbered lists (#34057) * style: use numbered lists Signed-off-by: aramissennyeydd * Update docs/contribute/doc-style-guide.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com> * fix prettier Signed-off-by: aramissennyeydd --------- Signed-off-by: aramissennyeydd Signed-off-by: Aramis Sennyey <159921952+aramissennyeydd@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/contribute/doc-style-guide.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/contribute/doc-style-guide.md b/docs/contribute/doc-style-guide.md index 3aa56b336f..1e28ed4676 100644 --- a/docs/contribute/doc-style-guide.md +++ b/docs/contribute/doc-style-guide.md @@ -228,6 +228,14 @@ helps downstream localization. - Use (`-`) for unordered lists. - Leave a blank line after each list. - Indent nested lists with two spaces. +- Use a numbered list for a sequence of steps rather than prose with + "First", "Then", and "Finally". Numbered lists are easier to scan, make + the order explicit, and give readers a clear way to reference a specific + step. + +| Do | Don't | +| :----------------------------------------------------------------- | :------------------------------------------------------------------------------ | +| 1) Install the package. 2) Run the migration. 3) Start the server. | First, install the package. Then, run the migration. Finally, start the server. | ### Tables