Skip to content

Commit 205cec7

Browse files
committed
fix(user): Tidy text and headers across Talk user documentation
- Fix grammar, articles, sentence case headings, stale intro text, duplicate content, and minor phrasing issues throughout Talk pages. - AI-assisted changes Signed-off-by: Maksim Sukharev <antreesy.web@gmail.com>
1 parent 14ec420 commit 205cec7

16 files changed

Lines changed: 50 additions & 49 deletions

user_manual/talk/appearance.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Appearance
55
Compact view of conversations list
66
----------------------------------
77

8-
Compact view allows to hide last message preview in the conversation list, providing a more focused interface.
8+
Compact view hides last message preview in the conversation list, providing a more focused interface.
99

1010
.. image:: images/talk-compact-view.png
1111
:width: 200px
@@ -16,7 +16,7 @@ Chat messages
1616
Chat appearance settings allow you to customize the look of your conversation chats.
1717
You can choose between classic list or message bubbles, with your own messages on the side.
1818

19-
You can change both settings from the ``Talk settings`` dialog in ``Appearance`` section.
19+
You can change both settings from the ``Talk settings`` dialog in the ``Appearance`` section.
2020

2121
.. image:: images/talk-appearance-settings.png
2222
:width: 600px

user_manual/talk/attachments.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Attachments
55
Sharing files in a chat
66
-----------------------
77

8-
You can share files in a chat in 3 ways.
8+
You can share files in a chat in three ways.
99

1010
First, you can simply drag'n'drop them on the chat.
1111

@@ -43,17 +43,17 @@ A poll has two settings:
4343
- **Anonymous polls**: Participants cannot see who voted for which option.
4444
- **Allow multiple choices**: Participants can select more than one option.
4545

46-
You can also import polls for auto-fill and export polls as JSON files to save it locally.
46+
You can also import polls for auto-fill and export polls as JSON files to save them locally.
4747

4848
.. image:: images/import-poll.png
4949
:width: 400px
5050

51-
Closing poll is possible from the poll dialog.
51+
You can close a poll from the poll dialog.
5252

5353
.. image:: images/close-poll.png
5454
:width: 400px
5555

56-
As a moderator, you can create the poll directly or you can save it as a draft to edit it later.
56+
As a moderator, you can create the poll directly or you can save it as a draft to edit it later.
5757

5858
.. image:: images/save-poll-draft.png
5959
:width: 400px

user_manual/talk/breakout_rooms.rst

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,20 @@
11
Breakout rooms
22
==============
33

4-
Breakout rooms allow you to divide a Nextcloud Talk call into smaller groups for more focused discussions. The moderator
5-
of the call can create multiple breakout rooms and assign participants to each room.
4+
Breakout rooms allow you to divide a Nextcloud Talk call into smaller groups for more focused discussions. The moderator of the call can create multiple breakout rooms and assign participants to each room.
65

76
.. note:: Breakout rooms are currently not available in conversations that are joinable by guests (public conversations).
87

98
Configure breakout rooms
109
------------------------
1110

12-
To create breakout rooms, you need to be a moderator in a group conversation. Click on the top-bar menu and click on
13-
"Setup breakout rooms".
11+
To create breakout rooms, you need to be a moderator in a group conversation. Click on the top-bar menu and click on ``Setup breakout rooms``.
1412

1513
.. image:: images/talk-breakout-rooms-setup.png
1614
:width: 400px
1715

1816
A dialog will open where you can specify the number of rooms you want to create and the participants assignment method.
19-
Here you'll be presented with 3 options:
17+
You have three options:
2018

2119
- **Automatically assign participants**: Talk will automatically assign participants to the rooms.
2220
- **Manually assign participants**: You'll go through a participants editor where you can assign participants to rooms.
@@ -33,7 +31,7 @@ Once the breakout rooms are created, you will be able to see them in the sidebar
3331
.. image:: images/talk-breakout-rooms-sidebar.png
3432
:width: 500px
3533

36-
From the sidebar header
34+
From the sidebar header, you can:
3735

3836
- **Start and stop the breakout rooms**: this will move all the users in the parent conversation to their respective breakout rooms.
3937
- **Broadcast a message to all the rooms**: this will send a message to all the rooms at the same time.

user_manual/talk/calendar_integration.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Calendar integration with Talk
44
Meetings and events
55
--------------------
66

7-
If calendar events have a Talk conversation set as event location, you will see an information about upcoming events inside of this conversation.
7+
If calendar events have a Talk conversation set as event location, you will see information about upcoming events inside of this conversation.
88
That way you can stay informed about scheduled meetings or activities directly within your chat.
99
If Calendar app is enabled, you can click on an event to view details.
1010

@@ -25,7 +25,7 @@ When creating a new event in Calendar, you can set a Talk conversation as event
2525
.. image:: images/calendar-create-event.png
2626
:width: 600px
2727

28-
When the event is created, you will see a link to the conversation in the event details. Conversation will also show up in the list of conversations (discoverable by ``Events`` filter).
28+
When the event is created, you will see a link to the conversation in the event details. The conversation will also appear in the list of conversations (discoverable by ``Events`` filter).
2929

3030
.. image:: images/event-conversation-list.png
3131
:width: 300px

user_manual/talk/call.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ The table in the CSV file contains the following columns:
8686
Call live transcription
8787
-----------------------
8888

89-
Call live transcription allows to transcribe the speech in real-time during a call. It is set up by the system administration (High-performance backend and `Live Transcription App <https://apps.nextcloud.com/apps/live_transcription>`_ are required).
89+
Call live transcription transcribes speech in real-time during a call. It is set up by the system administration (High-performance backend and `Live Transcription App <https://apps.nextcloud.com/apps/live_transcription>`_ are required).
9090
Moderators need to set the language of the transcription in the conversation settings. All participants then can enable or disable the transcription for themselves in the call bottom bar.
9191
When enabled, the transcription will appear in the bottom and will be updated in real-time.
9292

user_manual/talk/call_recording.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Call recording
22
==============
33

4-
The recording feature provides users with an opportunity to:
4+
The recording feature lets you:
55

66
- Start and stop recordings during a call.
77
- Record the video and audio stream of the speaker, as well as screen share.
@@ -43,7 +43,7 @@ After stopping a recording, the server will take some time to prepare and save t
4343
Recording consent
4444
-----------------
4545

46-
For compliance reasons with various privacy rights, it is possible to ask participants for consent to be recorded before joining the call. The system administration has the flexibility to utilize this feature in several ways:
46+
For compliance with privacy regulations, it is possible to ask participants for consent to be recorded before joining the call. Administrators can configure this feature in several ways:
4747

4848
- Disable consent completely.
4949
- Enable mandatory consent system-wide, requiring consent for all conversations.

user_manual/talk/chat.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Sending messages
55
Using Markdown
66
---------------
77

8-
You can enhance your messages with a markdown syntax support. See list for usage:
8+
You can enhance your messages using Markdown syntax. Supported elements:
99

1010
**Headings and dividers**
1111

@@ -81,8 +81,8 @@ You can add emoji using the picker on the left of the text input field.
8181
Smart Picker
8282
------------
8383

84-
Smart picker shortcut makes it easier to insert links, files, or other content into your conversations.
85-
Just choose the type of content you want to insert (files, Talk conversations, Deck cards, GIFs, etc.)
84+
The smart picker makes it easier to insert links, files, or other content into your conversations.
85+
Just choose the type of content you want to insert (files, Talk conversations, Deck cards, GIFs, etc.).
8686
You can also type `/` in the chat input to open the selector.
8787

8888
.. image:: images/smart-picker.png
@@ -130,7 +130,7 @@ You can find all your scheduled messages by clicking on the clock icon next to t
130130
Chat summary
131131
------------
132132

133-
When AI assistant is enabled, a summary can be generated if there are more than 100 unread messages.
133+
When AI assistant is enabled, a summary can be generated for a conversation if there are more than 100 unread messages.
134134
You can generate it by pressing the button that is visible in chat above the first unread messages.
135135

136136
.. image:: images/chat-summary-button.png

user_manual/talk/conversations.rst

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,13 @@
22
Conversations
33
=============
44

5-
Nextcloud Talk lets you chat and have video calls on your own server.
6-
75
Chats and calls take place in conversations. You can create any number of conversations. There are different types of conversations:
86

97
1. Private (one-to-one) conversations
108
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
119
This is where you have a private chat or call with another Talk user.
1210

13-
In content sidebar, you can find additional information about the person you are chatting with, such as their email address, phone number, or other details they have shared in their profile.
11+
In the content sidebar, you can find additional information about the person you are chatting with, such as their email address, phone number, or other details they have shared in their profile.
1412

1513
.. image:: images/one-to-one-right-sidebar.png
1614
:width: 300px
@@ -21,7 +19,7 @@ You can extend an ongoing call to a new group conversation by adding more people
2119
.. image:: images/one-to-one-extend.png
2220
:width: 300px
2321

24-
If a user becomes unavailable and set an **out-of-office** status in ``Personal settings > Availability``, you will find additional information in this conversation, such as provided description, absence date, or their replacement person.
22+
If a user becomes unavailable and has set an **out-of-office** status in ``Personal settings > Availability``, you will find additional information in this conversation, such as provided description, absence date, or their replacement person.
2523

2624
.. image:: images/one-to-one-out-of-office.png
2725
:width: 500px
@@ -108,7 +106,7 @@ Filter your conversations
108106
You can filter your conversations using the filter button next to the search field. There are several options for filtering:
109107
1. **Unread mentions**: view unread private conversations, or group conversations, where you have been mentioned.
110108
2. **Unread messages**: view unread messages in all conversations you are a part of.
111-
2. **Event conversations**: view all conversations, created for upcoming or past events.
109+
3. **Event conversations**: view all conversations, created for upcoming or past events.
112110

113111
.. image:: images/filters-menu.png
114112
:width: 400px
@@ -155,9 +153,9 @@ Ban participants
155153
----------------
156154

157155
To help keep discussions safe and under control, moderators can ban participants from conversations.
158-
It could be internal users or guests (in this case their IP-addresse will additionally be banned).
156+
This applies to internal users and guests alike; for guests, their IP address will also be banned.
159157

160-
In the participants list, select the user or guest you, and click ``Remove participant``.
158+
In the participants list, select the user or guest, and click ``Remove participant``.
161159

162160
.. image:: images/ban-participant.png
163161
:width: 300px

user_manual/talk/federation.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
11
Federation
22
==========
3-
With Federation feature, users can create conversations across different federated Talk instances and use Talk features as if they were on a same server.
43

5-
Feature is required to be set up by the system administration.
4+
With the Federation feature, users can create conversations across different federated Talk instances and use Talk features as if they were on the same server.
5+
6+
This feature must be enabled by a system administrator.
67

78
Sending an invitation
89
---------------------
910

1011
.. FIXME document where a user can find their CloudID to get invited
1112
12-
The moderator of the conversation can send an invite to participant on a different server:
13+
The moderator of the conversation can send an invite to a participant on a different server:
1314

1415
.. image:: images/federation-invite-send.png
1516
:width: 400px
1617

1718
Accepting an invitation
1819
-----------------------
1920

20-
When receiving a notification, user will see a counter of pending invites above the conversations list.
21+
When receiving a notification, the user will see a counter of pending invites above the conversations list.
2122

2223
.. image:: images/federation-invite-pending.png
2324
:width: 400px
2425

25-
Upon clicking it, more information will be provided about inviting party, and user can either accept or decline the invitation.
26+
Upon clicking it, more information will be provided about the inviting party, and the user can either accept or decline the invitation.
2627

2728
.. image:: images/federation-invite-dialog.png
2829
:width: 500px
2930

30-
By accepting the invite, conversation will appear in the list as any other one.
31+
By accepting the invite, the conversation will appear in the list as any other one.
3132

3233
.. image:: images/federation-conversations-list.png
3334
:width: 400px
3435

35-
You can use it further to chat with participants from other federated servers, join calls and use other available Talk features.
36+
You can use it to chat with participants from other federated servers, join calls, and use other available Talk features.

user_manual/talk/files_integration.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Files integration
44
Talk from Files
55
---------------
66

7-
In the Files app, you can chat about files in the sidebar, and even have a call while editing it. You first have to join the chat.
7+
In the Files app, you can chat about files in the sidebar, and even have a call while editing the file. You first have to join the chat.
88

99
.. image:: images/join-chat.png
1010
:width: 500px

0 commit comments

Comments
 (0)