Merge remote-tracking branch 'origin/docs/update-plugin-documentation' into 5.x

Author: cklei-carly

docs/content-drafts-revisions.md

@@ -43,9 +43,9 @@ Drafts are visible only in the admin panel and not on your live site.
 
 Drafts are clearly marked in the content list:
 
--   Status indicator shows "Draft"
--   Often color-coded differently from published content
--   Show an editing icon
+- Status indicator shows "Draft"
+- Often color-coded differently from published content
+- Show an editing icon
 
 ### Editing Drafts
 

docs/content-routing.md

@@ -4,7 +4,7 @@ slug: content-routing
 path: docs/v1/content-routing
 uri: /docs/v1/content-routing
 heading: Content Routing
-brief: 
+brief:
 quick_links: []
 ---
 
@@ -30,8 +30,8 @@ By default, content URLs follow a hierarchical structure:
 
 For example:
 
--   `/about`: A top-level "About" page
--   `/products/widgets/blue-widget`: A "Blue Widget" page under the "Widgets" section of "Products"
+- `/about`: A top-level "About" page
+- `/products/widgets/blue-widget`: A "Blue Widget" page under the "Widgets" section of "Products"
 
 ---
 
@@ -88,8 +88,8 @@ Content slugs are URL-friendly versions of content titles used in routes.
 
 When creating content, InspireCMS automatically generates a slug from the title:
 
--   "Hello World" becomes "hello-world"
--   "Top 10 Tips & Tricks" becomes "top-10-tips-tricks"
+- "Hello World" becomes "hello-world"
+- "Top 10 Tips & Tricks" becomes "top-10-tips-tricks"
 
 ### Custom Slugs
 
@@ -104,42 +104,44 @@ To use a custom slug:
 
 Slugs must:
 
--   Contain only lowercase letters, numbers, and hyphens
--   Not conflict with existing routes or reserved words
--   Be unique within their parent section
+- Contain only lowercase letters, numbers, and hyphens
+- Not conflict with existing routes or reserved words
+- Be unique within their parent section
 
 ### Customizing the Slug Generator
+
 You can customize how slugs are generated by modifying the `slug_generator` setting in your configuration file. Here's how:
 
 1. Locate `frontend` section in the `config/inspirecms.php` file.
 
 2. **Edit the Slug Generator**:
    Change the `slug_generator` to your custom class:
-   ```php
-   'frontend' => [
-       'slug_generator' => \App\CustomSlugGenerator::class,
-   ],
-   ```
+
+    ```php
+    'frontend' => [
+        'slug_generator' => \App\CustomSlugGenerator::class,
+    ],
+    ```
 
 3. **Create Your Custom Slug Generator**:
    Implement your custom slug generator class:
-   ```php
-   namespace App;
 
-   use SolutionForest\InspireCms\Content\DefaultSlugGenerator;
+    ```php
+    namespace App;
 
-   class CustomSlugGenerator extends DefaultSlugGenerator {
-       public function generate($text, $language = DefaultSlugGenerator::LANG_AUTO, $separator = '-') {
-           // Custom logic for slug generation
-           return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $text)));
-       }
-   }
-   ```
+    use SolutionForest\InspireCms\Content\DefaultSlugGenerator;
+
+    class CustomSlugGenerator extends DefaultSlugGenerator {
+        public function generate($text, $language = DefaultSlugGenerator::LANG_AUTO, $separator = '-') {
+            // Custom logic for slug generation
+            return strtolower(trim(preg_replace('/[^A-Za-z0-9-]+/', '-', $text)));
+        }
+    }
+    ```
 
 4. **Test Your Changes**:
    After saving your configuration and custom class, create new content or edit existing content to see your custom slug generation in action.
 
-
 ---
 
 ## Route Registration
@@ -210,9 +212,9 @@ php artisan route:clear
 
 This is useful after:
 
--   Bulk content changes
--   Changing route configuration
--   Upgrading InspireCMS
+- Bulk content changes
+- Changing route configuration
+- Upgrading InspireCMS
 
 ---
 
@@ -308,11 +310,11 @@ class AppServiceProvider extends ServiceProvider
 
 ### Managing Content Redirects
 
--   Edit the content item in the admin panel
--   Navigate to the "SEO" tab
--   Scroll down to the "Redirect" section
--   Set the destination URL and redirect type (301 permanent, 302 temporary)
--   Save the content
+- Edit the content item in the admin panel
+- Navigate to the "SEO" tab
+- Scroll down to the "Redirect" section
+- Set the destination URL and redirect type (301 permanent, 302 temporary)
+- Save the content
 
 ---
 
@@ -326,7 +328,7 @@ php artisan inspirecms:routes
 
 This command shows all registered content routes with:
 
--   URL pattern
--   Name
--   Bindings
--   Middleware
+- URL pattern
+- Name
+- Bindings
+- Middleware

docs/customize-the-admin-panel.md

@@ -12,12 +12,12 @@ quick_links: []
 
 The InspireCMS admin panel is built on [Filament](https://filamentphp.com/), a powerful admin panel framework for Laravel applications. This integration allows you to:
 
--   Create custom admin pages
--   Add new resources for managing database models
--   Organize related functionality into clusters
--   Define custom dashboard widgets
--   Extend existing admin functionality
--   Customize the look and feel of the admin panel
+- Create custom admin pages
+- Add new resources for managing database models
+- Organize related functionality into clusters
+- Define custom dashboard widgets
+- Extend existing admin functionality
+- Customize the look and feel of the admin panel
 
 ---
 
@@ -846,7 +846,7 @@ class StatsOverview extends BaseWidget
 
 ## Further Resources
 
--   [Filament Documentation](https://filamentphp.com/docs)
--   [Laravel Documentation](https://laravel.com/docs)
+- [Filament Documentation](https://filamentphp.com/docs)
+- [Laravel Documentation](https://laravel.com/docs)
 
 With these tools and techniques, you can extend and customize the InspireCMS admin panel to suit your specific requirements while maintaining a consistent and user-friendly interface.

docs/fe-content.md

@@ -210,11 +210,11 @@ $paginatedContentDto = inspirecms_content()->getPaginatedByDocumentType(document
 
 ## Best Practices
 
--   Use `inspirecms_content()` helper for retrieving content instead of direct database queries
--   Always check if properties exist before using them
--   Cache frequent content queries for better performance
--   For large content sets, use pagination to improve page load times
--   Use property directives in Blade templates for cleaner syntax
+- Use `inspirecms_content()` helper for retrieving content instead of direct database queries
+- Always check if properties exist before using them
+- Cache frequent content queries for better performance
+- For large content sets, use pagination to improve page load times
+- Use property directives in Blade templates for cleaner syntax
 
 > [!note]
 >

docs/installing.md

@@ -4,7 +4,7 @@ slug: installing
 path: docs/v1/installing
 uri: /docs/v1/installing
 heading: Installing
-brief: 
+brief:
 quick_links: []
 ---
 
@@ -14,6 +14,16 @@ Before beginning installation, ensure your environment meets the [system require
 
 ---
 
+## Version Compatibility
+
+| Filament Version | Plugin Version |
+| ---------------- | -------------- |
+| v3               | 1.x.x          |
+| v4               | 4.x.x          |
+| v5               | 5.x.x          |
+
+---
+
 ## Standard Installation
 
 ### Step 1: Create a Laravel Application
@@ -85,8 +95,8 @@ InspireCMS requires queue workers and scheduled jobs for image conversion, backg
 
 For development, you can run these commands manually in separate terminals:
 
--   `php artisan queue:work` (for background jobs)
--   `php artisan schedule:work` (for scheduled tasks)
+- `php artisan queue:work` (for background jobs)
+- `php artisan schedule:work` (for scheduled tasks)
 
 For detailed configuration options, refer to the [Laravel Queue documentation](https://laravel.com/docs/queues) and [Task Scheduling documentation](https://laravel.com/docs/scheduling).
 

docs/media.md

@@ -19,17 +19,17 @@ The media library is accessible from: **Admin Panel** > **Media**
 
 The media library interface includes:
 
--   **Folders**: Organize media in a hierarchical structure
--   **Search**: Find media by filename, type, or metadata
--   **Filters**: Filter by date, file type, or custom attributes
--   **Sorting**: Arrange files by name, date or size
+- **Folders**: Organize media in a hierarchical structure
+- **Search**: Find media by filename, type, or metadata
+- **Filters**: Filter by date, file type, or custom attributes
+- **Sorting**: Arrange files by name, date or size
 
 ### File Details
 
 Click on a file to view detailed information:
 
--   **Properties**: Technical information (dimensions, format, size)
--   **Actions**: Download, edit, move, or delete
+- **Properties**: Technical information (dimensions, format, size)
+- **Actions**: Download, edit, move, or delete
 
 ---
 
@@ -148,13 +148,13 @@ Generate responsive image variants:
 
 Every media file includes standard metadata:
 
--   Filename
--   File type and extension
--   File size
--   Upload date
--   Uploader
--   Dimensions (for images)
--   Duration (for audio/video)
+- Filename
+- File type and extension
+- File size
+- Upload date
+- Uploader
+- Dimensions (for images)
+- Duration (for audio/video)
 
 ### Custom Metadata
 
@@ -291,9 +291,9 @@ class MediaAssetPolicy extends BasePolicy
 
 ## Best Practices
 
--   **Organize Logically**: Use a consistent folder structure
--   **Meaningful Filenames**: Use descriptive, URL-friendly filenames
--   **Complete Metadata**: Add alt text and descriptions for accessibility
--   **Optimize Images**: Use appropriate file formats and compression
--   **Responsive Images**: Use responsive techniques for different screen sizes
--   **Accessibility**: Ensure all media has appropriate alt text
+- **Organize Logically**: Use a consistent folder structure
+- **Meaningful Filenames**: Use descriptive, URL-friendly filenames
+- **Complete Metadata**: Add alt text and descriptions for accessibility
+- **Optimize Images**: Use appropriate file formats and compression
+- **Responsive Images**: Use responsive techniques for different screen sizes
+- **Accessibility**: Ensure all media has appropriate alt text