From 896cebb17c48837300800e1988b4ecef220a8fb0 Mon Sep 17 00:00:00 2001 From: Alya Abbott Date: Thu, 12 Oct 2023 11:12:49 -0700 Subject: [PATCH] help: Create documentation about reading conversations. Combine instructions for topics and direct messages. --- help/all-messages.md | 4 +- help/finding-a-topic-to-read.md | 15 +++-- help/getting-started-with-zulip.md | 18 +++--- help/include/reading-topics.md | 54 +++--------------- help/include/sidebar_index.md | 5 +- help/reading-strategies.md | 91 +++++++++++++++++++++++------- help/reading-topics.md | 9 +-- help/recent-conversations.md | 6 +- help/streams-and-topics.md | 4 +- 9 files changed, 110 insertions(+), 96 deletions(-) diff --git a/help/all-messages.md b/help/all-messages.md index 878b3c2853..21f64c01d9 100644 --- a/help/all-messages.md +++ b/help/all-messages.md @@ -11,7 +11,7 @@ ## Related articles * [Reading strategies](/help/reading-strategies) -* [Recent conversations](/help/recent-conversations) * [Inbox](/help/inbox) +* [Recent conversations](/help/recent-conversations) * [Configure default view](/help/configure-default-view) -* [Reading topics](/help/reading-topics) +* [Reading conversations](/help/reading-topics) diff --git a/help/finding-a-topic-to-read.md b/help/finding-a-topic-to-read.md index 288e5a01b3..bd930c8eca 100644 --- a/help/finding-a-topic-to-read.md +++ b/help/finding-a-topic-to-read.md @@ -1,16 +1,20 @@ -# Finding a topic to read +# Finding a conversation to read -Like your email inbox, Zulip works best if you read it topic-by-topic. +{!conversation-definition.md!} + +{!conversation-recommendation.md!} ## From the Inbox view -{!inbox.md!} +{!inbox-intro.md!} + +{!inbox-instructions.md!} ## From Recent conversations {!recent-conversations.md!} -## From the list of streams +## From the left sidebar {!left-sidebar-topics.md!} @@ -18,5 +22,4 @@ Like your email inbox, Zulip works best if you read it topic-by-topic. * [Getting started with Zulip](/help/getting-started-with-zulip) * [Reading strategies](/help/reading-strategies) -* [Reading topics](/help/reading-topics) -* [Reading direct messages (DMs)](/help/reading-dms) +* [Reading conversations](/help/reading-topics) diff --git a/help/getting-started-with-zulip.md b/help/getting-started-with-zulip.md index eabcabd522..fa951817d8 100644 --- a/help/getting-started-with-zulip.md +++ b/help/getting-started-with-zulip.md @@ -18,30 +18,30 @@ it, you'll never want to use a different team chat app! ## Reading your messages -Like your email inbox, Zulip works best if you read it topic-by-topic. +{!conversation-definition.md!} -### Finding a topic to read +{!conversation-recommendation.md!} + +### Finding a conversation to read #### From the Inbox view -{!inbox.md!} +{!inbox-intro.md!} + +{!inbox-instructions.md!} #### From Recent conversations {!recent-conversations.md!} -#### From the list of streams +#### From the left sidebar {!left-sidebar-topics.md!} -### Reading topics +### Reading conversations {!reading-topics.md!} -### Reading direct messages - -{!reading-dms.md!} - ## Sending messages ### When to start a new topic diff --git a/help/include/reading-topics.md b/help/include/reading-topics.md index 0104c64735..fdc356a44f 100644 --- a/help/include/reading-topics.md +++ b/help/include/reading-topics.md @@ -1,60 +1,20 @@ {start_tabs} -{tab|via-inbox-view} +{tab|desktop-web} -{relative|message|inbox} +1. [Find](/help/finding-a-topic-to-read) a conversation to read. -1. Click on the name of a topic. - -1. Read the topic, scrolling down with the mouse or by pressing +1. Read the conversation, scrolling down with the mouse or by pressing PgDn. -1. If the topic is not of interest, you can +1. If the conversation is not of interest, you can [mark all messages as read](/help/marking-messages-as-read) by jumping to the bottom with the **Scroll to bottom** () button or the End shortcut. -1. You can then click on another topic in the left sidebar, use the - N key to go to the next unread topic, or go back to the - **Inbox** view. +!!! keyboard_tip "" -{tab|via-recent-conversations} - -{relative|message|recent} - -1. Click on the name of a topic in the **Topic** column. - -1. Read the topic, scrolling down with the mouse or by pressing - PgDn. - -1. If the topic is not of interest, you can - [mark all messages as read](/help/marking-messages-as-read) by - jumping to the bottom with the **Scroll to bottom** - () button or the End shortcut. - -1. You can then click on another topic in the left sidebar, use the - N key to go to the next unread topic, or go back to the - **Recent conversations** view. - -{tab|via-left-sidebar} - -1. Click on the name of a stream in the left sidebar. You will see a - list of the most recent unread topics in that stream. - -1. Click on a topic in the left sidebar. - -1. Read the topic, scrolling down with the mouse or by pressing - PgDn. - -1. If the topic is not of interest, you can - [mark all messages as read](/help/marking-messages-as-read) by - jumping to the bottom with the **Scroll to bottom** - () button or the End shortcut. - -1. Click on the next topic in the left sidebar, or use the N - key to go to the next unread topic. - -1. To go to older unread topics, use the N key or click - **more topics** to view. + Use the N key to go to the next unread topic, or P + to go to the next unread direct message conversation. {end_tabs} diff --git a/help/include/sidebar_index.md b/help/include/sidebar_index.md index cc85a23d30..786fa0f0ac 100644 --- a/help/include/sidebar_index.md +++ b/help/include/sidebar_index.md @@ -10,9 +10,8 @@ * [Joining an organization](/help/join-a-zulip-organization) * [Set up your account](/help/set-up-your-account) * [Streams and topics](/help/streams-and-topics) -* [Finding a topic to read](/help/finding-a-topic-to-read) -* [Reading topics](/help/reading-topics) -* [Reading direct messages (DMs)](/help/reading-dms) +* [Finding a conversation to read](/help/finding-a-topic-to-read) +* [Reading conversations](/help/reading-topics) * [Starting a new topic](/help/starting-a-new-topic) * [Starting a new direct message](/help/starting-a-new-direct-message) * [Replying to messages](/help/replying-to-messages) diff --git a/help/reading-strategies.md b/help/reading-strategies.md index 86e4da76c8..fb4c586786 100644 --- a/help/reading-strategies.md +++ b/help/reading-strategies.md @@ -5,55 +5,106 @@ the message is about. If you are not yet familiar with Zulip's topics, we recommend first reading about [streams and topics](/help/streams-and-topics). -This article details a few ways to efficiently read through messages +This article describes a few ways to efficiently read through messages in Zulip. -## Topic by topic +## Conversation by conversation -Like your email inbox, for most users, Zulip works best if you read it -topic-by-topic. +{!conversation-definition.md!} -### Finding a topic to read +{!conversation-recommendation.md!} + +### Finding a conversation to read #### From the Inbox view -{!inbox.md!} +{!inbox-intro.md!} + +{!inbox-instructions.md!} #### From Recent conversations {!recent-conversations.md!} -#### From the list of streams +#### From the left sidebar {!left-sidebar-topics.md!} -### Reading topics +### Reading conversations {!reading-topics.md!} -## Stream view +## Combined views + +### All messages + +{!all-messages.md!} + +### All direct messages + +You can see all your direct messages in one place. + +{start_tabs} + +{tab|desktop-web} + +1. Click on the **All direct messages** icon next to **DIRECT MESSAGES** in the left sidebar. + +1. Read your direct messages, starting from your first unread message. You can + scroll using your mouse, the arrow keys, End, or page up/down. + +1. You can click on a conversation in the left sidebar or a message recipient bar to + narrow to messages from that conversation. + +!!! keyboard_tip "" + + Use the Shift + P keyboard shortcut to go to + **All direct messages**. + +{end_tabs} + +### Stream view Sometimes it's useful to scroll through all the messages in a stream, especially in situations where you just want a general idea of what's going on. -* Click on a stream name in the left sidebar, and scroll using your mouse, - the arrow keys, End, or page up/down. +{start_tabs} -* Click on a topic to narrow to messages from that topic. +{tab|desktop-web} -You can also search for a stream by clicking on **STREAMS** in the -left sidebar, or using the Q [keyboard -shortcut](/help/keyboard-shortcuts). +1. Find the stream you want to read in the left sidebar. If you don't see it + right away, you can search for a stream by clicking on **STREAMS** in the + left sidebar, or using the Q [keyboard + shortcut](/help/keyboard-shortcuts). -## All messages +1. Click on the stream name in the left sidebar. -{!all-messages.md!} +1. Read messages in the stream, starting from your first unread message. You can + scroll using your mouse, the arrow keys, End, or page up/down. -## Starring messages for later +1. You can click on a topic in the left sidebar or a message recipient bar to + narrow to messages from that topic. -You can [star messages](/help/star-a-message) that you've seen and would -like to reply to later. +{end_tabs} + +## Special views + +### Mentions + +The mentions view lets you quickly find all the places where you were +[mentioned](/help/mention-a-user-or-group). Reviewing your mentions can be a +good way to start your day. + +{!view-mentions.md!} + +### Starred messages + +You can [star messages](/help/star-a-message) that you plan to follow up on later. + +#### View starred messages + +{!view-starred-messages.md!} ## Related articles diff --git a/help/reading-topics.md b/help/reading-topics.md index fe271754cf..0062fbdb04 100644 --- a/help/reading-topics.md +++ b/help/reading-topics.md @@ -1,12 +1,13 @@ -# Reading topics +# Reading conversations -Like your email inbox, Zulip works best if you read it topic-by-topic. +{!conversation-definition.md!} + +{!conversation-recommendation.md!} {!reading-topics.md!} ## Related articles * [Getting started with Zulip](/help/getting-started-with-zulip) -* [Finding a topic to read](/help/finding-a-topic-to-read) -* [Reading direct messages (DMs)](/help/reading-dms) +* [Finding a conversation to read](/help/finding-a-topic-to-read) * [Reading strategies](/help/reading-strategies) diff --git a/help/recent-conversations.md b/help/recent-conversations.md index f976b34be8..39a4275419 100644 --- a/help/recent-conversations.md +++ b/help/recent-conversations.md @@ -8,9 +8,9 @@ L, H) can be used to move between elements. ## Related articles -* [Finding a topic to read](/help/finding-a-topic-to-read) -* [Reading topics](/help/reading-topics) +* [Finding a conversation to read](/help/finding-a-topic-to-read) +* [Reading conversations](/help/reading-topics) * [Reading strategies](/help/reading-strategies) -* [All messages](/help/all-messages) * [Inbox](/help/inbox) +* [All messages](/help/all-messages) * [Configure default view](/help/configure-default-view) diff --git a/help/streams-and-topics.md b/help/streams-and-topics.md index 8cec35f578..9c1a65e301 100644 --- a/help/streams-and-topics.md +++ b/help/streams-and-topics.md @@ -6,8 +6,8 @@ ## Further reading * [Getting started with Zulip](/help/getting-started-with-zulip) -* [Finding a topic to read](/help/finding-a-topic-to-read) -* [Reading topics](/help/reading-topics) +* [Finding a conversation to read](/help/finding-a-topic-to-read) +* [Reading conversations](/help/reading-topics) * [Starting a new topic](/help/starting-a-new-topic) * [Replying to messages](/help/replying-to-messages) * [Creating streams for your organization](/help/getting-your-organization-started-with-zulip#create-streams)