Skip to content

Commit

Permalink
[Docs] Improve AdminUi documentation (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
loic425 authored Oct 15, 2024
2 parents fc3c122 + 6f53de8 commit 73b79e6
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 2 deletions.
2 changes: 2 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ The Sylius stack is a set of tools for your Symfony projects:

* [Minimalist generic templates for your admin panels](admin-ui/getting-started.md)
* [Build your Bootstrap admin panels with Sylius and Symfony UX](bootstrap-admin-ui/getting-started.md)
* [Resource management system, routing and CRUD operations](https://github.com/Sylius/SyliusResourceBundle/blob/1.13/docs/index.md)
* [Amazing grids with support of filters and custom fields integrated into Symfony](https://github.com/Sylius/SyliusGridBundle/blob/1.13/docs/index.md)
* [Additional Twig extensions for your Symfony projects](twig-extra/getting-started.md)
* [Composable Twig layouts](twig-hooks/getting-started.md)
* [Basic UI translations](ui-translations/getting-started.md)
Expand Down
46 changes: 45 additions & 1 deletion docs/admin-ui/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
description: >-
Admin UI contains minimalist generic templates for your admin panels.
Admin UI contains minimalist generic templates and routes for your admin panels.
---

# Getting started
Expand All @@ -12,3 +12,47 @@ Install the package using Composer and Symfony Flex:
```bash
composer require sylius/admin-ui
```

## Basic routes

- __Dashboard__ - sylius_admin_ui_dashboard
- __Login__ - sylius_admin_ui_login
- __LoginCheck__ - sylius_admin_ui_login_check
- __Logout__ - sylius_admin_ui_logout

## Minimalist templates

### Crud templates

- crud/create.html.twig
- crud/index.html.twig
- crud/show.html.twig
- crud/update.html.twig

*Usage with Sylius Resource package*

```php
// src/Entity/Speaker.php

namespace App\Entity;

use Sylius\Resource\Metadata\AsResource;
use Sylius\Resource\Model\ResourceInterface;

#[AsResource(
templatesDir: '@SyliusAdminUi/crud',
)]
class Speaker implements ResourceInterface
{
// ...
}

```

### Dashboard

- dashboard/index.html.twig

### Login

- security/login.html.twig
2 changes: 1 addition & 1 deletion src/AdminUi/composer.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "sylius/admin-ui",
"description": "Minimalist generic templates for your admin panels",
"description": "Minimalist generic templates and routes for your admin panels",
"type": "library",
"require": {
"php": "^8.1",
Expand Down

0 comments on commit 73b79e6

Please sign in to comment.