Merge pull request #16 from SmartBase-SK/develop

triv: #24416 extended documentation

Author: LuboZ

docs/dashboard.mdx

@@ -8,7 +8,7 @@ import TabItem from '@theme/TabItem';
 SmartBase Admin supports dashboard views that can include charts, lists, and aggregate widgets for analytical and operational insight.
 You can fully customize and extend dashboards to fit your use case.
 
-![Dashboard](/img/screenshots/dashboard.png)
+![Dashboard](/img/screenshots/dashboard_big.png)
 
 ## 🛠 How It Works
 

docs/detail/_category_.json

@@ -1,6 +1,6 @@
 {
   "label": "Detail view",
-  "position": 4,
+  "position": 5,
   "link": {
     "type": "generated-index",
     "description": "Integration examples"

docs/detail/classes.mdx

@@ -1,6 +1,6 @@
 ---
 title: Fieldset Layout Classes
-sidebar_position: 3
+sidebar_position: 1
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

docs/detail/fake_inlines.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 2
+sidebar_position: 4
 title: Fake Inlines
 ---
 import Tabs from '@theme/Tabs';
@@ -10,6 +10,10 @@ import TabItem from '@theme/TabItem';
 SBAdminFakeInlineMixin is used to create inlines that are dynamically filtered — without needing a real ForeignKey relationship in the database. This is useful when you want to show related data based on some logic (e.g. "products from the same manufacturer") but don’t want to (or can't) define a hard model relation.
 
 These inlines are rendered like standard inlines but do not impact database schema.
+
+![Fake inlines](/img/screenshots/fake_inline_example.png)
+
+
 ## 🛠 How it works
 - Define inline which extending `SBAdminFakeInlineMixin`
 - For inline, define `filter_fake_inline_identifier_by_parent_instance(self, inline_queryset, parent_instance)`. This controls what queryset will be shown in the inline, based on the parent instance.
@@ -21,11 +25,11 @@ This example showcases a fake inline for a Product admin page that lists other p
 ```python title="catalog/sb_admin.py"
 class ProductSameManufacturerInline(SBAdminFakeInlineMixin, SBAdminTableInline):
     model = Product
-    fields = ["name", "is_current_product"]
-    readonly_fields = ["name", "is_current_product"]
+    fields = ["name", "price", "is_active", "created", "is_current_product"]
+    readonly_fields = fields
     can_delete = False
-    verbose_name = "Product from the same manufacturer"
-    verbose_name_plural = "Products from the same manufacturer"
+    verbose_name = "Product from the same manufacturer - Fake inline example"
+    verbose_name_plural = "Products from the same manufacturer - Fake inline example"
 
     def has_add_permission(self, request, obj=None):
         return False

docs/detail/inlines.mdx

@@ -1,5 +1,5 @@
 ---
-sidebar_position: 1
+sidebar_position: 3
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

docs/detail/tabs.mdx

@@ -1,11 +1,11 @@
 ---
-title: Detail View Tabs
-sidebar_position: 4
+title: Tabs
+sidebar_position: 2
 ---
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 
-### Detail View Tabs
+# Tabs
 
 SmartBase Admin allows you to organize fieldsets and inlines into tabs using the `sbadmin_tabs` configuration
 

docs/installation.md

@@ -5,6 +5,7 @@ title: Quick start
 # Getting Started
 
 Smartbase Admin is a powerful extension for Django projects, providing a customizable admin interface. Follow the steps below to install and configure it in your project.
+![Dashboard](/img/screenshots/dashboard_big.png)
 
 ---
 

docs/menu.mdx

@@ -7,7 +7,7 @@ import TabItem from '@theme/TabItem';
 # Menu
 This section demonstrates how to define menu items using the SBAdminRoleConfiguration class.
 
-### Defining Menu Items
+## Defining Menu Items
 To create a custom menu, define a list of SBAdminMenuItem instances and pass them to SBAdminRoleConfiguration.
 
 ```python title="sb_admin_configuration.py"
@@ -31,4 +31,62 @@ Each `SBAdminMenuItem` accepts the following key parameters:
 - `view_id`: Unique identifier of the view this item links to.
 - `icon` (optional): The icon name from [🔗 Available icons](https://github.com/SmartBase-SK/django-smartbase-admin/tree/main/src/django_smartbase_admin/static/sb_admin/sprites/sb_admin).
 - `label` (optional): Overrides the default label.
-- `sub_items` (optional): A list of nested SBAdminMenuItem objects, supporting menu nesting.
+- `sub_items` (optional): A list of nested SBAdminMenuItem objects, supporting menu nesting.
+
+## Role-Based Menu Configuration
+You can define different menus for different user roles by extending SBAdminRoleConfiguration and using get_configuration_for_roles in your SBAdminConfiguration.
+
+### Step 1: Define Menu Variants
+
+
+```python title="sb_admin_configuration.py"
+admin_menu_items = [
+    SBAdminMenuItem(view_id="dashboard", icon="All-application"),
+    SBAdminMenuItem(
+        label="Catalog",
+        icon="Box",
+        sub_items=[
+            SBAdminMenuItem(view_id="catalog_product", label="Products"),
+            SBAdminMenuItem(view_id="catalog_category", label="Categories"),
+            SBAdminMenuItem(view_id="catalog_manufacturer", label="Manufacturers"),
+        ],
+    ),
+    SBAdminMenuItem(view_id="catalog_product", label="List View", icon="List-checkbox"),
+    SBAdminMenuItem(view_id="catalog_purchase", label="Advanced filters", icon="Filter"),
+]
+
+editor_menu_items = [
+    SBAdminMenuItem(view_id="catalog_product", icon="List-checkbox", label="List View"),
+    SBAdminMenuItem(view_id="catalog_category", icon="List-checkbox", label="Tree View"),
+    SBAdminMenuItem(view_id="catalog_manufacturer", icon="Box"),
+]
+```
+
+### Step 2: Create Role-Based Configurations
+
+```python title="sb_admin_configuration.py"
+class AdminConfiguration(SBAdminRoleConfiguration):
+    menu_items = admin_menu_items
+    default_view = SBAdminMenuItem(view_id="dashboard")
+    registered_views = [...]
+
+
+class EditorConfiguration(SBAdminRoleConfiguration):
+    menu_items = editor_menu_items
+    default_view = SBAdminMenuItem(view_id="catalog_product")
+    registered_views = [...]
+```
+
+### Step 3: Return the Configuration Based on User Role
+```python title="sb_admin_configuration.py"
+EDITOR_ROLE = "Editors"
+
+class SBAdminConfiguration(SBAdminConfigurationBase):
+    def get_configuration_for_roles(self, user_roles):
+        user_roles = list(user_roles)
+        if EDITOR_ROLE in user_roles:
+            return EditorConfiguration()
+        return AdminConfiguration()
+```
+
+With this setup, each user will see a customized menu based on their role. You can extend this further to support more roles or dynamic permissions.

docs/table/_category_.json

@@ -1,6 +1,6 @@
 {
-  "label": "Table",
-  "position": 5,
+  "label": "List view",
+  "position": 4,
   "link": {
     "type": "generated-index",
     "description": "Table listing"

docs/table/filters.mdx

@@ -57,3 +57,21 @@ class ProductSBAdmin(SBAdmin):
 </TabItem>
 
 </Tabs>
+
+# Advanced Filters
+To enable advance filters you have to set filter version in your `SBAdminRoleConfiguration`
+
+<Tabs groupId="1">
+<TabItem value="code" label="Code">
+```python title="sb_admin_configuration.py"
+class SBAdminConfiguration(SBAdminConfigurationBase):
+    filters_version = FilterVersions.FILTERS_VERSION_2,
+```
+
+</TabItem>
+<TabItem value="list" label="Result">
+![Category sbadmin](/img/screenshots/advanced_filters.png)
+</TabItem>
+
+</Tabs>
+