docs: add README, boost skill, and documentation site

2026-03-27 00:29:57 +04:00
parent 29fcbd8aec
commit b8d930df1a
25 changed files with 1741 additions and 3 deletions
--- a/docs/content/2.essentials/1.configuration.md
+++ b/docs/content/2.essentials/1.configuration.md
@@ -0,0 +1,189 @@
+---
+title: Configuration
+description: Configure threading, reactions, mentions, attachments, notifications, and more.
+navigation:
+  icon: i-lucide-settings
+seo:
+  description: Complete configuration reference for the Comments package.
+---
+
+Publish the configuration file:
+
+```bash
+php artisan vendor:publish --tag=comments-config
+```
+
+This creates `config/comments.php` with all available options.
+
+## Table Name
+
+```php
+'tables' => [
+    'comments' => 'comments',
+],
+```
+
+Change the table name if it conflicts with your application.
+
+## Models
+
+```php
+'models' => [
+    'comment' => \Relaticle\Comments\Comment::class,
+],
+
+'commenter' => [
+    'model' => \App\Models\User::class,
+],
+```
+
+Override the Comment model to add custom behavior. The commenter model defines which class represents the user who comments.
+
+## Policy
+
+```php
+'policy' => \Relaticle\Comments\Policies\CommentPolicy::class,
+```
+
+See the [Authorization](/essentials/authorization) page for customization details.
+
+## Threading
+
+```php
+'threading' => [
+    'max_depth' => 2,
+],
+```
+
+Controls how many levels of nested replies are allowed. A depth of `2` means top-level comments and one level of replies. Set to `1` to disable replies entirely.
+
+## Pagination
+
+```php
+'pagination' => [
+    'per_page' => 10,
+],
+```
+
+Number of comments loaded initially and per "Load More" click.
+
+## Reactions
+
+```php
+'reactions' => [
+    'emoji_set' => [
+        'thumbs_up' => "\u{1F44D}",
+        'heart' => "\u{2764}\u{FE0F}",
+        'celebrate' => "\u{1F389}",
+        'laugh' => "\u{1F604}",
+        'thinking' => "\u{1F914}",
+        'sad' => "\u{1F622}",
+    ],
+],
+```
+
+Customize the available emoji reactions. Keys are used as identifiers in the database, values are the displayed emoji characters.
+
+## Mentions
+
+```php
+'mentions' => [
+    'resolver' => \Relaticle\Comments\Mentions\DefaultMentionResolver::class,
+    'max_results' => 5,
+],
+```
+
+The resolver handles searching for users during @mention autocomplete. See the [Mentions](/essentials/mentions) page for creating a custom resolver.
+
+## Editor Toolbar
+
+```php
+'editor' => [
+    'toolbar' => [
+        ['bold', 'italic', 'strike', 'link'],
+        ['bulletList', 'orderedList'],
+        ['codeBlock'],
+    ],
+],
+```
+
+Defines which formatting buttons appear in the comment editor. Groups create visual separators in the toolbar.
+
+## Notifications
+
+```php
+'notifications' => [
+    'channels' => ['database'],
+    'enabled' => true,
+],
+```
+
+Add `'mail'` to the channels array to send email notifications. Set `enabled` to `false` to disable all notifications.
+
+## Subscriptions
+
+```php
+'subscriptions' => [
+    'auto_subscribe' => true,
+],
+```
+
+When enabled, users are automatically subscribed to a thread when they create a comment or are mentioned. They receive notifications for subsequent replies.
+
+## Attachments
+
+```php
+'attachments' => [
+    'enabled' => true,
+    'disk' => 'public',
+    'max_size' => 10240, // KB
+    'allowed_types' => [
+        'image/jpeg',
+        'image/png',
+        'image/gif',
+        'image/webp',
+        'application/pdf',
+        'text/plain',
+        'application/msword',
+        'application/vnd.openxmlformats-officedocument.wordprocessingml.document',
+    ],
+],
+```
+
+Controls file upload behavior. Set `enabled` to `false` to remove the attachment UI entirely. The `max_size` is in kilobytes (default 10 MB).
+
+## Broadcasting
+
+```php
+'broadcasting' => [
+    'enabled' => false,
+    'channel_prefix' => 'comments',
+],
+```
+
+When enabled, comment events are broadcast on private channels using the format `{prefix}.{commentable_type}.{commentable_id}`. Requires Laravel Echo and a broadcasting driver.
+
+## Polling
+
+```php
+'polling' => [
+    'interval' => '10s',
+],
+```
+
+When broadcasting is disabled, the Livewire component polls for new comments at this interval. Set to `null` to disable polling.
+
+## Custom User Resolution
+
+Override how the authenticated user is resolved:
+
+```php
+use Relaticle\Comments\Config;
+
+// In AppServiceProvider::boot()
+Config::resolveAuthenticatedUserUsing(function () {
+    return auth()->user();
+});
+```
+
+This is useful for multi-guard applications or custom authentication flows.