From c5ac5cce82e1339911a365b4fa0eb60914aec096 Mon Sep 17 00:00:00 2001 From: Jabber Developer Date: Thu, 21 Aug 2025 15:05:29 +0200 Subject: [PATCH] Improve wording of the quick start guide --- .../docs/getting-started/quick-start.md | 99 ++++++++++--------- 1 file changed, 50 insertions(+), 49 deletions(-) diff --git a/src/content/docs/getting-started/quick-start.md b/src/content/docs/getting-started/quick-start.md index e16a148..0f54f5e 100644 --- a/src/content/docs/getting-started/quick-start.md +++ b/src/content/docs/getting-started/quick-start.md @@ -9,16 +9,16 @@ sidebar:
-To start CProof, run the following at the command line: +To start CProof, run the following command in the terminal: ```bash -$ profanity +profanity ``` -To see options available to the command: +To view the available options for the command: ```bash -$ profanity -h +profanity -h ``` ## User Interface @@ -26,11 +26,11 @@ $ profanity -h ![CProof User Interface](@assets/CProof-ui-1.webp) The user interface is split into five main areas: -1. **Title Bar:** Shows the name of the person or chat room you’re with, plus your current status (e.g., online or away). It’s configurable using the [`/titlebar`](/command-reference/#titlebar) command. -2. **Main Window Area:** Used to show the current active window. The first window (1) is reserved for the 'console' where system messages, roster and some command responses are shown. -3. **Roster Subwindow:** Lists your contacts, their online status, and any new messages. -4. **Status Bar:** Displays the current time, your logged-in account, and the status of open windows. A highlighted number indicates new messages, while "-1-" marks the currently active window. It's configurable using the [`/statusbar`](/command-reference/#statusbar) command. -5. **Input Area:** Where you type messages or commands. Press Tab to autocomplete them easily. +1. **Title Bar**: Displays the name of the contact or chat room you're with, along with your current status (e.g., online or away). It's configurable using the [`/titlebar`](/command-reference/#titlebar) command. +2. **Main Window Area**: Shows the currently active window. The first window (1) is reserved for the 'console', which displays system messages, the roster, and some command responses. +3. **Roster Subwindow**: Lists your contacts, their online status, and any new messages. +4. **Status Bar**: Shows the current time, your logged-in account, and the status of open windows. A highlighted number indicates new messages, while "-1-" marks the active window. It's configurable using the [`/statusbar`](/command-reference/#statusbar) command. +5. **Input Area**: Lets you type messages or commands. Press Tab to autocomplete commands easily. All commands start with a / character. For example, [`/help`](/command-reference/#help). @@ -40,7 +40,7 @@ All commands start with a / character. For example, [`/help`](/command-reference To use CProof, you first need to register a Jabber ID (JID) and then add your account. -If you don’t have a JID yet, use the [`/register`](/command-reference/#register) command to create one. If you already have a JID, you can skip this step. +If you don’t have a JID yet, use the [`/register`](/command-reference/#register) command to create one. ```bash /register nickname example.com @@ -65,7 +65,20 @@ Finally, connect to your account using the [`/connect`](/command-reference/#conn /connect main_account ``` -To make it easier for yourself in the future, add autoconnect to this account. It will ensure that you are automatically connected to that account on each login: +#### Account Management Tips + +To connect to an XMPP chat service without adding account: + +```bash +/connect user@server.com +``` + +You will be prompted by the status bar to enter your password. + +See the [`/connect`](/command-reference#connect) command for additional arguments that may be used when connecting. + +To simplify future logins, enable autoconnect for an account. This ensures automatic connection on each login: + ```bash /autoconnect set main_account ``` @@ -73,7 +86,7 @@ To make it easier for yourself in the future, add autoconnect to this account. I ## Window Navigation -To make a window visible in the main window area, use any of the following: +To switch the active window, use any of the following: `Alt-1` to `Alt-0` @@ -95,18 +108,6 @@ To close the current window: /close ``` -## Connecting - -To connect to an XMPP chat service: - -```bash -/connect user@server.com -``` - -You will be prompted by the status bar to enter your password. - -See the [`/connect`](/command-reference#connect) command for additional arguments that may be used when connecting. - ## One to one chat To open a new window and send a message use the [`/msg`](/command-reference#msg) command: @@ -127,6 +128,28 @@ Once a window is opened with the contact, messages can be sent by just typing th Hows it going? ``` +## Adding contacts + +Add someone to the roster with the following command: + +```bash +/roster add newfriend@server.chat.com +``` + +To subscribe to contacts' presence (to receive notifications about online/offline status, checkmarks for message delivery, and other related features): + +```bash +/sub request newfriend@server.chat.com +``` + +To approve a contact's request to subscribe to your presence: + +```bash +/sub allow newfriend@server.chat.com +``` + +See the [`/roster`](/command-reference#roster) and [`/sub`](/command-reference#sub) commands for more detail. + ## Chat rooms To join a chat room, use the [`/join`](/command-reference#join) command: @@ -141,29 +164,7 @@ Once a window is opened for the room, messages can be sent by just typing them i Hello everyone ``` -See the chat [`Chat room guide`](/guides/chat-rooms) for more detail. - -## Adding contacts - -To add someone to your roster: - -```bash -/roster add newfriend@server.chat.com -``` - -To subscribe to a contacts presence (to be notified when they are online/offline etc): - -```bash -/sub request newfriend@server.chat.com -``` - -To approve a contact's request to subscribe to your presence: - -```bash -/sub allow newfriend@server.chat.com -``` - -See the [`/roster`](/command-reference#roster) and [`/sub`](/command-reference#sub) commands for more detail. +See the [`Chat room guide`](/guides/chat-rooms) for more detail. ## Changing your presence @@ -185,13 +186,13 @@ Each of these commands accepts a message as a parameter, so to show the message ## Logging out -To log out from the current chat service: +To log out from the current account: ```bash /disconnect ``` -To quit CProof: +To exit CProof: ```bash /quit