feat: folder docs

adomin.code-workspace

@@ -17,5 +17,8 @@
       "source.organizeImports": "explicit",
       "source.fixAll": "explicit",
     },
+    "files.associations": {
+      "*.mdx": "markdown"
+    }
   },
 }

app/adomin/config/adomin_config.ts

@@ -1,4 +1,5 @@
 import { AdominConfig } from '#adomin/adomin_config.types'
+import { ADOMIN_TEST_CONFIG } from '../../test_adomin_config.js'
 
 /**
  * This file will contain your Adomin Config
@@ -18,5 +19,6 @@ import { AdominConfig } from '#adomin/adomin_config.types'
 
 export const ADOMIN_CONFIG: AdominConfig = {
   title: 'Your Backoffice Title',
-  views: [],
+  views: [...ADOMIN_TEST_CONFIG],
+  // plugins: ['cms'],
 }

docs/src/content/docs/reference/views/folders/index.mdx

@@ -0,0 +1,67 @@
+---
+title: Folder views
+sidebar:
+  order: 1001
+description: Adomin folder views reference
+---
+
+Folder views allows to organize your other views in a tree structure.
+
+![Folder view](~/assets/images/reference/folders/folder_view.png)
+
+## Config
+
+To declare a folder view, you will need to add a `FolderViewConfig` object inside the `views` array of the `app/adomin/config/adomin_config.ts` file.
+
+```ts
+export const ADOMIN_CONFIG: AdominConfig = {
+	title: 'Adomin',
+	views: [MY_FOLDER_CONFIG],
+}
+```
+
+Use the `createFolderViewConfig` function to create your `FolderViewConfig` object:
+
+```ts
+export const MY_FOLDER_CONFIG = createFolderViewConfig({
+  label: 'My folder',
+  name: 'my-folder',
+  views: [STATS_CONFIG, USER_CONFIG],
+  icon: 'folder',
+})
+```
+
+You can pass the following options inside the config object:
+
+### label
+
+Title of the folder, displayed in the sidebar
+
+### name
+Used to determine the path in the frontend
+
+e.g. if name = 'test', full path on the frontend will be `/adomin/folders/test`
+
+### views
+
+The folder children views, each object should be a `ModelConfig`, `StatsViewConfig` or `FolderViewConfig`
+
+### visibilityCheck
+
+Check if logged in user can see this folder
+
+### isHidden
+
+Use this if you want to hide this folder on the frontend.
+Frontend routes will still be created and available, but the navbar won't show them.
+
+:::caution
+Do not see this as a protection, but rather a cosmetic feature.
+
+If you want to protect things, use [visibilityCheck](#visibilityCheck)
+:::
+
+### icon
+
+Icon name, by default this uses Tabler icons
+You can browse the list of available icons at: https://tabler.io/icons

docs/src/content/docs/reference/views/models/index.mdx

@@ -1,7 +1,7 @@
 ---
 title: Model views
 sidebar:
-  order: 1001
+  order: 1002
 description: Adomin model views reference
 ---
 
@@ -139,6 +139,11 @@ Do not see this as a protection, but rather a cosmetic feature.
 If you want to protect things, use [staticRights](#staticrights), [visibilityCheck](#visibilitycheck) and [crudlRights](#crudlrights)
 :::
 
+### icon
+
+Icon name, by default this uses Tabler icons
+You can browse the list of available icons at: https://tabler.io/icons
+
 ### queryBuilderCallback
 
 You can use this callback to customize the query built for this model in order to do custom things on the frontend, or if you use computed fields who needs query customizations or preloads

docs/src/content/docs/reference/views/stats/index.mdx

@@ -1,7 +1,7 @@
 ---
 title: Stat views
 sidebar:
-  order: 1002
+  order: 1003
 description: Adomin stats views reference
 ---
 
@@ -31,6 +31,10 @@ For this, you will need to write some backend configuration, and then the adomin
 
 ![Area chart](~/assets/images/reference/stats/area.png)
 
+### Kpi chart
+
+![Kpi chart](~/assets/images/reference/stats/kpi.png)
+
 ## Config
 
 To declare a stat view page, you will need to add a `StatViewConfig` object inside the `views` array of the `app/adomin/config/adomin_config.ts` file.
@@ -94,6 +98,11 @@ Do not see this as a protection, but rather a cosmetic feature.
 If you want to protect things, use [visibilityCheck](#visibilitycheck)
 :::
 
+### icon
+
+Icon name, by default this uses Tabler icons
+You can browse the list of available icons at: https://tabler.io/icons
+
 ### stats
 
 An array of `AdominStat` objects, each `AdominStat` represent a chart
@@ -113,6 +122,7 @@ Type of the chart to display, can be one of:
 - column
 - line
 - area
+- kpi
 
 ### label