From 35e4cf6bf697bf7d22b8b85afdf59e39c4f1e3f5 Mon Sep 17 00:00:00 2001 From: Shubham Padia Date: Mon, 23 Jun 2025 09:40:22 +0000 Subject: [PATCH] help: Ordered list item should always be followed by an indented line. Our help-beta conversion script expects text to be indented if the text is part of the same list item. If it is not part of the same list item, then it expects an empty line just after the list item. This commit fixes existing instances for the same by searching for regex: `^1\. .*\n(?!\n)(?!1\.)( {0,1}\S.*)`. We do not want to add a lint rule for this, since not indenting is not technically wrong. We will add a TODO list item in the conversion script for help-beta in future commits. --- api_docs/integrations-overview.md | 2 +- help/add-a-custom-linkifier.md | 2 +- help/change-the-time-format.md | 2 +- help/code-blocks.md | 3 ++- help/desktop-app-install-guide.md | 2 +- help/dm-mention-alert-notifications.md | 2 +- help/format-a-quote.md | 1 + help/include/communities-directory-instructions.md | 4 ++-- help/include/edit-organization-profile.md | 2 +- help/include/switching-between-organizations.md | 2 +- help/latex.md | 1 + help/logging-in.md | 4 ++-- help/logging-out.md | 2 +- help/mastering-the-compose-box.md | 2 +- help/organization-type.md | 2 +- help/user-list.md | 2 +- help/using-zulip-via-email.md | 2 +- 17 files changed, 20 insertions(+), 17 deletions(-) diff --git a/api_docs/integrations-overview.md b/api_docs/integrations-overview.md index 5e5e7f1eee..054091551d 100644 --- a/api_docs/integrations-overview.md +++ b/api_docs/integrations-overview.md @@ -46,7 +46,7 @@ additional integrations through [Zapier](https://zapier.com/apps) and {start_tabs} 1. Search [Zapier](https://zapier.com/apps) or [IFTTT](https://ifttt.com/search) -for the product you'd like to connect to Zulip. + for the product you'd like to connect to Zulip. 1. Follow the integration instructions for [Zapier](/integrations/doc/zapier) or [IFTTT](/integrations/doc/ifttt). diff --git a/help/add-a-custom-linkifier.md b/help/add-a-custom-linkifier.md index 6ad52ee217..c7af2a054b 100644 --- a/help/add-a-custom-linkifier.md +++ b/help/add-a-custom-linkifier.md @@ -21,7 +21,7 @@ support](/help/contact-support) with details on what you're trying to do. {settings_tab|linkifier-settings} 1. Under **Add a new linkifier**, enter a **Pattern** and -**URL template**. + **URL template**. 1. Click **Add linkifier**. diff --git a/help/change-the-time-format.md b/help/change-the-time-format.md index ee0407386b..60b2033df3 100644 --- a/help/change-the-time-format.md +++ b/help/change-the-time-format.md @@ -10,6 +10,6 @@ format (e.g., 5:00 PM) or a 24-hour format (e.g., 17:00). {settings_tab|preferences} 1. Under **General**, select your preferred option from the -**Time format** dropdown. + **Time format** dropdown. {end_tabs} diff --git a/help/code-blocks.md b/help/code-blocks.md index 1f1ccfcd9e..013568ccf1 100644 --- a/help/code-blocks.md +++ b/help/code-blocks.md @@ -39,6 +39,7 @@ formatting: {!start-composing.md!} 1. To create an inline code span, use single backticks around the text: + ~~~ `text` ~~~ @@ -125,7 +126,7 @@ on hover that allows you to open the code block in the code playground site. {settings_tab|playground-settings} 1. Under **Add a new code playground**, enter a **Language**, **Name**, and -**URL template**. + **URL template**. 1. Click **Add code playground**. diff --git a/help/desktop-app-install-guide.md b/help/desktop-app-install-guide.md index e1b410e488..3be23c6d7b 100644 --- a/help/desktop-app-install-guide.md +++ b/help/desktop-app-install-guide.md @@ -106,7 +106,7 @@ You can run the command `brew upgrade zulip` to immediately upgrade the app. #### Flathub 1. Make sure you have [Flatpak](https://flathub.org/setup) installed on your -system. + system. 1. Use the following command from the official [Flathub page](https://flathub.org/apps/org.zulip.Zulip) to install Zulip: diff --git a/help/dm-mention-alert-notifications.md b/help/dm-mention-alert-notifications.md index 31677b5218..d1e0fde1b0 100644 --- a/help/dm-mention-alert-notifications.md +++ b/help/dm-mention-alert-notifications.md @@ -24,7 +24,7 @@ messages) from desktop notifications. {start_tabs} 1. Under **Desktop message notifications**, toggle -**Include content of direct messages in desktop notifications**. + **Include content of direct messages in desktop notifications**. {end_tabs} diff --git a/help/format-a-quote.md b/help/format-a-quote.md index 7c3e323b9f..c1a03dacb4 100644 --- a/help/format-a-quote.md +++ b/help/format-a-quote.md @@ -25,6 +25,7 @@ {!start-composing.md!} 1. To create a multi-line quote, type `>` followed by a space and some text: + ~~~ > a multi-line quote on two lines diff --git a/help/include/communities-directory-instructions.md b/help/include/communities-directory-instructions.md index b0f19e5d26..41b13a4345 100644 --- a/help/include/communities-directory-instructions.md +++ b/help/include/communities-directory-instructions.md @@ -3,10 +3,10 @@ {settings_tab|organization-profile} 1. To be listed in the appropriate category, under **Organization type**, select -the option that best fits your organization. + the option that best fits your organization. 1. Toggle **Advertise organization in the Zulip communities -directory**. + directory**. {!save-changes.md!} diff --git a/help/include/edit-organization-profile.md b/help/include/edit-organization-profile.md index 82e18801a7..1183841788 100644 --- a/help/include/edit-organization-profile.md +++ b/help/include/edit-organization-profile.md @@ -3,7 +3,7 @@ {settings_tab|organization-profile} 1. Edit your organization **name**, **type**, **description**, and -**profile picture**. + **profile picture**. 1. *(optional)* Click **Preview organization profile** to see a preview of your organization's login page in a new browser tab. diff --git a/help/include/switching-between-organizations.md b/help/include/switching-between-organizations.md index f731137ee1..657f2eaaaf 100644 --- a/help/include/switching-between-organizations.md +++ b/help/include/switching-between-organizations.md @@ -9,7 +9,7 @@ {tab|desktop} 1. Click on a logo in the **organizations sidebar** on the left, or choose -an organization from the **Window** menu in the top menu bar. + an organization from the **Window** menu in the top menu bar. {!desktop-toggle-sidebar-tip.md!} diff --git a/help/latex.md b/help/latex.md index 49a92f3cbf..0e7cfb8574 100644 --- a/help/latex.md +++ b/help/latex.md @@ -35,6 +35,7 @@ formatting: {!start-composing.md!} 1. To use inline LaTeX, use double dollar signs (`$$`) around the text: + ~~~ $$O(n^2)$$ ~~~ diff --git a/help/logging-in.md b/help/logging-in.md index 9b8c6641b1..811d17cd85 100644 --- a/help/logging-in.md +++ b/help/logging-in.md @@ -84,8 +84,8 @@ Here are some ways to find the URL for your Zulip organization. [custom certificate](/help/custom-certificates). 1. Click the **plus** () icon in the -**organizations sidebar** on the left. You can also select **Add Organization** -from the **Zulip** menu in the top menu bar. + **organizations sidebar** on the left. You can also select **Add Organization** + from the **Zulip** menu in the top menu bar. 1. Enter the Zulip URL of the organization, and click **Connect**. diff --git a/help/logging-out.md b/help/logging-out.md index 90fef35297..5001d07087 100644 --- a/help/logging-out.md +++ b/help/logging-out.md @@ -4,7 +4,7 @@ {tab|desktop-web} 1. Click the **gear** () icon in the top -right corner of the app. + right corner of the app. 1. Click **Log out**. diff --git a/help/mastering-the-compose-box.md b/help/mastering-the-compose-box.md index c3c96b3d3c..c4f6cb4f3d 100644 --- a/help/mastering-the-compose-box.md +++ b/help/mastering-the-compose-box.md @@ -74,7 +74,7 @@ currently composing to. {settings_tab|preferences} 1. Under **Navigation**, toggle **Automatically go to conversation -where you sent a message**, as desired. + where you sent a message**, as desired. {end_tabs} diff --git a/help/organization-type.md b/help/organization-type.md index 3db3d5ad71..3543d597cd 100644 --- a/help/organization-type.md +++ b/help/organization-type.md @@ -11,7 +11,7 @@ {settings_tab|organization-profile} 1. Under **Organization type**, select the option that best fits -your organization. + your organization. {!save-changes.md!} diff --git a/help/user-list.md b/help/user-list.md index e48cdf1101..1eda84ac97 100644 --- a/help/user-list.md +++ b/help/user-list.md @@ -71,7 +71,7 @@ user list. {tab|desktop-web} 1. Click the **user list** ( -) icon in the upper right. + ) icon in the upper right. !!! keyboard_tip "" diff --git a/help/using-zulip-via-email.md b/help/using-zulip-via-email.md index 60c4a4eab1..1405185532 100644 --- a/help/using-zulip-via-email.md +++ b/help/using-zulip-via-email.md @@ -30,7 +30,7 @@ If you want to interact with Zulip primarily (or entirely) via your email client {start_tabs} 1. [Subscribe](/help/introduction-to-channels#browse-and-subscribe-to-channels) to any channels you are -interested in. + interested in. {settings_tab|notifications}