From a5dcdebfa7bf9bb7729b21f7ca6c2bf15b1e0edb Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Fri, 17 Sep 2021 17:33:10 -0700 Subject: [PATCH] help: Add basic documentation for stream descriptions. --- templates/zerver/help/change-the-stream-description.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/templates/zerver/help/change-the-stream-description.md b/templates/zerver/help/change-the-stream-description.md index 55ebf248de..2483f6be7e 100644 --- a/templates/zerver/help/change-the-stream-description.md +++ b/templates/zerver/help/change-the-stream-description.md @@ -1,5 +1,13 @@ # Change the stream description +Streams descriptions are displayed when viewing the stream in the +apps, and can be used to explain the purpose of a stream and link to +usage guidelines, resources, or related streams. + +Stream descriptions support Zulip's standard [Markdown +formatting][markdown-formatting], with the exception that image +previews are disabled. + {!admin-only.md!} {start_tabs} @@ -14,3 +22,5 @@ 1. Click the **checkmark** to save. {end_tabs} + +[markdown-formatting]: /help/format-your-message-using-markdown