Skip to content

Commit 86435b3

Browse files
committed
[TASK] Add visuals
1 parent 4b6d2e6 commit 86435b3

5 files changed

Lines changed: 14 additions & 0 deletions

File tree

213 KB
Loading
180 KB
Loading
226 KB
Loading

Documentation/Introduction.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,10 +192,14 @@ Every AI request is tracked in the **AiM > Request Log** module:
192192

193193
Filter by provider, extension, request type, or success/failure. Statistics dashboard shows totals at a glance.
194194

195+
![Request Log](Images/request-log.png)
196+
195197
### Provider verification
196198

197199
Click the verify button next to any provider configuration to test the connection. See "connected" or "disconnected" with the exact error message. Results are persisted so you see the last check status on every page load.
198200

201+
![Provider Management](Images/provider-management.png)
202+
199203
### Disabled models
200204

201205
In the Available Providers modal, click any model badge to disable it. Disabled models:
@@ -215,6 +219,8 @@ If the TYPO3 Dashboard extension is installed, AiM adds five widgets you can pla
215219

216220
A pre-configured dashboard preset ("AiM: AI Analytics") is available when creating a new dashboard, placing all five widgets at once.
217221

222+
![Dashboard Widgets](Images/dashboard-widgets.png)
223+
218224
---
219225

220226
## For extension developers

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ AiM is the central AI layer for TYPO3. Extensions describe what they need. AiM d
44

55
> **New to AiM?** Read the [Introduction](Documentation/Introduction.md) for a non-technical overview of what AiM does, why it exists, and how it works for administrators and extension developers.
66
7+
> **Alpha state.** AiM is under active development. The API is functional but may change before 1.0. We'd love your feedback: [open an issue](https://github.com/b13/aim/issues) or reach out at [b13.com](https://b13.com).
8+
9+
![AiM Request Log](Documentation/Images/request-log.png)
10+
711
## Quick start
812

913
```php
@@ -487,6 +491,8 @@ Manage AI provider configurations:
487491
- **Provider verification**: test connectivity with a minimal probe request, results persisted
488492
- **Last used**: timestamp per configuration with link to request log
489493

494+
![Provider Management](Documentation/Images/provider-management.png)
495+
490496
### Request Log
491497

492498
Monitor all AI requests:
@@ -512,6 +518,8 @@ When `typo3/cms-dashboard` is installed, AiM registers five widgets and a pre-co
512518

513519
All widgets are refreshable and grouped under "AiM" in the widget picker. The recent requests widget includes a button to open the full request log module.
514520

521+
![Dashboard Widgets](Documentation/Images/dashboard-widgets.png)
522+
515523
## Database Tables
516524

517525
| Table | Purpose |

0 commit comments

Comments
 (0)