Skip to content

Commit cc4ade6

Browse files
committed
docs: Complete initial copy for tutorial.
1 parent fb7f4b0 commit cc4ade6

File tree

1 file changed

+28
-22
lines changed

1 file changed

+28
-22
lines changed

docs/getting-started.md

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ If you encountered any issues above or have any queries, feel free to ask for he
88
I would like you to try out a few of our keyboard shortcuts and send a couple message to help you get familiar with zulip terminal. Here's an overview of the features I'll be walking you through:
99

1010
### Overview
11-
0. Open the App
11+
0. [Open the App](#Open-the-App)
1212
1. [Understand the Layout](#Understand-the-Layout)
1313
2. [Shortcuts](#Shortcuts)
14-
3. Reading Messages
15-
4. What does Narrow Mean?
16-
i. [Narrow to a Stream](#Narrow-to-a-Stream)
17-
ii. [Narrow to a Topic in a Stream](#Narrow-to-a-Topic-in-a-Stream)
18-
iii. Switch Topics and/or Streams
19-
5. Sending Messages
20-
i. [Create a New Topic](#Create-a-New-Topic)
21-
ii. [Reply to a Message](#Reply-to-a-Message)
22-
iii. [Send a Private Message](#Send-a-Private-Message)
14+
3. [Reading Messages](#Reading-Messages)
15+
4. [What does Narrow Mean?](#What-does-Narrow-Mean?)
16+
+ [Narrow to a Stream](#Narrow-to-a-Stream)
17+
+ [Narrow to a Topic in a Stream](#Narrow-to-a-Topic-in-a-Stream)
18+
+ [Switch Topics and/or Streams](#Switch-Topics-and/or-Streams)
19+
5. [Sending Messages](#Sending-Messages)
20+
+ [Create a New Topic](#Create-a-New-Topic)
21+
+ [Reply to a Message](#Reply-to-a-Message)
22+
+ [Send a Private Message](#Send-a-Private-Message)
2323
6. [Edit a Message's Text or Topic](#Edit-a-Message's-Text-or-Topic)
2424
7. [Close Zulip Terminal](#Close-Zulip-Terminal)
2525

@@ -61,8 +61,8 @@ You can use narrows to filter which messages you want displayed in the middle co
6161

6262
### What does 'Narrow' mean?
6363

64-
** Noun: A narrow is a set of filters for Zulip messages, that can be based on many different factors (like sender, stream, topic, search keywords, etc.).
65-
** Verb: Essentially the process navigating to a more specific narrow. Ie to go from viewing a stream to a topic within that stream.
64+
+ **Noun**: A narrow is a set of filters for Zulip messages, that can be based on many different factors (like sender, stream, topic, search keywords, etc.).
65+
+ **Verb**: Essentially the process navigating to a more specific narrow. For example, to go from viewing a stream to a topic within that stream.
6666

6767
#### How to Tell What Your Current Narrow Is
6868

@@ -73,15 +73,12 @@ Image with circle around 'all messages' at top of middle column.
7373
#### Narrow to a Stream
7474
Narrowing to a stream implies you have set middle column to show messages present in only that stream. There are several different ways to narrow to a stream:
7575

76-
1. Using <kbd>z</kbd>.
7776

78-
If you're scrolling through All Messages <kbd>a</kbd> and want to only see messages from a specific stream, first make sure your cursor is on a message from the stream you want to narrow to. Then press <kbd>z</kbd>.
79-
80-
2. Using the Arrow Keys
77+
1. Using the Arrow Keys
8178

8279
For this example, let's try narrowing to [# backend](https://chat.zulip.org/#narrow/stream/3-backend) from zulip terminal. Press <kbd>left</kbd> to navgiate to the left column. Then press the <kbd>down</kbd> key until your cursor rests on `backend`. Press enter to narrow to the stream.
8380

84-
3. Use Search to Narrow to a Stream
81+
2. Use Search to Narrow to a Stream
8582

8683
Narrowing to backend was easy because it was near the top of the streams list, but say you want to narrow to a stream that's farther down or isn't even displayed in the streams list...in this case you can use Search.
8784

@@ -93,7 +90,7 @@ Narrowing to a stream implies you have set middle column to show messages presen
9390

9491
1. Using <kbd>z</kbd>
9592

96-
If you're scrolling through the messages in a stream and want to only see messages from a specific topic, first make sure your cursor is on a message from the topic you want to narrow to. Then press <kbd>z</kbd>. If you aren't yet in that stream, first this will narrow you to the message's stream. Press <kbd>z</kbd> again to narrow to the topic.
93+
If you're scrolling through the messages in a stream (or in all messages) and want to only see messages from a specific topic, first make sure your cursor is on a message from the topic you want to narrow to. Then press <kbd>z</kbd>. If you aren't yet in that stream, first this will narrow you to the message's stream. Press <kbd>z</kbd> again to narrow to the topic.
9794

9895
2. Using <kbd>t</kbd> and the Arrow Keys
9996

@@ -105,17 +102,26 @@ Just like with example two, make sure your cursor is in the left column and rest
105102

106103
#### Switching Topic and Stream
107104

108-
To go back out of a stream/topic use <kbd>esc</kbd> to go back to wherever you where last.
105+
Use <kbd>esc</kbd> to go back to wherever you where last.
109106

110107
### Sending Messages
111108

109+
To reply to a message in a narrow (stream/topic/PM), rest your cursor on the message you want to reply to and then type <kbd>r</kbd>. Type your message in the Message box that pops up at the bottom of the middle column. Type <kbd>ctrl</kbd><kbd>d</kbd> to send. If you change your mind and don't want to send the message, type <kbd>esc</kbd> to get out of the message editor.
110+
112111
#### Create a New Topic
113112

114-
#### Reply to a Message
113+
To send a new message to a stream, type <kbd>c</kbd> and a message editor will pop open at the bottom of the middle column. Make sure your cursor is in the middle column, otherwise nothing will happen when you type <kbd>c</kbd>.
114+
115+
By default this will send a new message to your current stream. Let's send a test message to [# test here](https://chat.zulip.org/#narrow/stream/7-test-here). If you're not already in the # test here stream, replace the stream name with test here. Add a topic and the message content. Use <kbd>tab</kbd> to navigate through the Message editor sections. Type <kbd>ctrl</kbd><kbd>d</kbd> to send.
115116

116117
#### Send a Private Message
117118

119+
To send a private message type <kbd>x</kbd> from anywhere in Zulip Terminal. A message editor box will pop open at the bottom of the middle column. Type in the name of the person (or people) you'd like to send a PM to. Then type in the body of the message. Type <kbd>ctrl</kbd><kbd>d</kbd> to send.
120+
118121
### Edit a Message's Text or Topic
119-
If you erase the entire message, the message will show up as "deleted".
120122

121-
### Close Zulip Terminal
123+
To edit a message, first make sure your cursor is resting on the message you want to edit then type <kbd>e</kbd>. If you erase the entire message, the message will show up as "deleted". Type <kbd>ctrl</kbd><kbd>d</kbd> to update the message.
124+
125+
### Close Zulip Terminal
126+
127+
To exit out of the Zulip Terminal app, type <kbd>ctrl</kbd><kbd>c</kbd>.

0 commit comments

Comments
 (0)