docs: add optional metadata field to chatroom creation and clarify sender relationship in messages

Author: mwargan

composer.json

@@ -1,8 +1,8 @@
 {
     "name": "mmedia/le-chat",
     "type": "library",
-    "version": "0.0.1",
-    "description": "This is my package le-chat",
+    "version": "0.1.0",
+    "description": "Add chat functionality to your Laravel application.",
     "keywords": [
         "Michal",
         "laravel",

docs/src/content/docs/chatrooms.md

@@ -18,6 +18,9 @@ use Mmedia\LeChat\Models\Chatroom;
 $chatroom = Chatroom::create([
     'name' => 'General Chat',
     'description' => 'A chatroom for general discussions',
+    'metadata' => [
+        'foo' => 'bar', // Optional metadata for the chatroom
+    ],
 ]);
 ```
 

docs/src/content/docs/messages.md

@@ -81,6 +81,8 @@ $sender = $message->sender; // Returns the participant who sent the message
 ```
 This returns the `ChatParticipant` morph model, which represents the participant who sent the message. This is by design, letting you work with a unified interface for all participants, regardless of their underlying model.
 
+Remember that not all messages have a sender. For example, system messages do not have a sender, so the `sender` relationship may return `null` in those cases.
+
 ### Returning the actual model that sent the message
 This will return an instance of the `ChatParticipant` model, which you can then use to get the actual model that sent the message (e.g., a User model).
 ```php

docs/src/content/docs/notifications.md

@@ -38,7 +38,7 @@ foreach ($notifiableParticipants as $participant) {
 ## Default New Message Notification
 The default notification is `\Mmedia\LeChat\Notifications\NewMessage::class`, which will send a notification to each of the participants personal channels when a new message is created, except the sender of the message, via the [Broadcasting](/broadcasting) channel.
 
-If you have `WebPush` channel installed, the notification will automatically be sent via web-push if the participant is not connected to the chatroom via sockets. This is useful for sending notifications to users who are not currently online in the chatroom.
+If you have the `WebPush` channel installed, the notification will automatically be sent via web-push if the participant is not connected to the chatroom via sockets. This is useful for sending notifications to users who are not currently online in the chatroom.
 
 ### Difference from the event broadcast
 The `NewMessage` notification is sent to the personal channel of each participant, while the event is broadcasted to the chatroom presence channel. This means that the notification will be sent to each participant individually, while the event is sent to the chatroom as a whole.

docs/src/content/docs/participants.md

@@ -110,6 +110,25 @@ If you want to use a different date range, you can use the `whereHasUnreadMessag
 $users = User::whereHasUnreadMessages(7, true)->get(); // unread messages sent in the last 7 days, including system messages
 ```
 
+## Getting a personal chatroom
+You can retrieve a "personal chatroom" for a participant, which is a chatroom that only contains that participant. This is useful for sending notifications or system messages that are not part of any other chatroom.
+
+```php
+$personalChatroom = $teacher->getOrCreatePersonalChatroom(); // Will return the first chatroom that only contains the teacher as a participant
+```
+
+If you want to configure the personal chatroom if its created, you can pass an array of attributes to the `getOrCreatePersonalChatroom` method:
+
+```php
+$teacher->getOrCreatePersonalChatroom([
+    'name' => 'My Personal Chatroom',
+    'description' => 'This is my personal chatroom for notifications and system messages, and sometimes notes.',
+    'metadata' => [
+        'foo' => 'bar', // Optional metadata for the personal chatroom
+    ],
+]);
+```
+
 ## Working with the intermediate morph model
 Le Chat uses an intermediate morph model called `ChatParticipant` to manage the relationships between your chattable models and the chatrooms they participate in.
 
@@ -118,7 +137,7 @@ This model represents a participant in a chatroom and contains additional inform
 The intermediate model is more than just a pivot table; it allows you to have a unified representation of all participants in a chatroom, separate from your own models. This allows you to maximise the separation of concerns between your application logic and the chat functionality.
 
 ### Getting the intermediate model from your model
-You can retrieve the `ChatParticipant` instance for a specific participant using the `chatParticipant` method on your model:
+You can retrieve the `ChatParticipant` instance for a specific participant using the `asParticipantIn` method on your model:
 ```php
 $chatParticipant = $teacher->asParticipantIn($chatroom);
 ```
@@ -172,20 +191,4 @@ $chatrooms = Chatroom::hasParticipant([$teacher, $chatParticipant]); // Will ret
 The model itself also implements the `ChatParticipantInterface`, and uses the trait, so you can use it in the same way as your own models:
 ```php
 $chatParticipant->sendMessageTo($student, 'Hello from the chat participant!');
-```
-
-## Getting a personal chatroom
-You can retrieve a "personal chatroom" for a participant, which is a chatroom that only contains that participant. This is useful for sending notifications or system messages that are not part of any other chatroom.
-
-```php
-$personalChatroom = $teacher->getOrCreatePersonalChatroom(); // Will return the first chatroom that only contains the teacher as a participant
-```
-
-If you want to configure the personal chatroom if its created, you can pass an array of attributes to the `getOrCreatePersonalChatroom` method:
-
-```php
-$teacher->getOrCreatePersonalChatroom([
-    'name' => 'My Personal Chatroom',
-    'description' => 'This is my personal chatroom for notifications and system messages, and sometimes notes.',
-]);
 ```

docs/src/content/docs/routing.md

@@ -7,7 +7,7 @@ description: Documentation for Le Chat routing.
 Le Chat provides a powerful set of API routes for managing chatrooms and sending messages. These routes are automatically registered by the package.
 
 ## Configuration
-Routes are enabled by default. If you publish the package configuration file, you can customize the middleware and prefix used for the API routes in `config/chat.php`:
+Routes are enabled by default. You can customize the middleware and prefix used for the API routes in `config/chat.php`:
 
 ```php
 'features' => [