Skip to content

Commit 827ceaa

Browse files
committed
Update docs + screenshots
1 parent f4ec697 commit 827ceaa

File tree

9 files changed

+13
-18
lines changed

9 files changed

+13
-18
lines changed

README.md

Lines changed: 10 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ This package makes use of [several great open-source packages](#used-packages) t
8080
* [License](#license)
8181

8282
<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
83-
<!-- Added by: sten, at: Thu Sep 11 00:02:19 CEST 2025 -->
83+
<!-- Added by: sten, at: Mon Sep 29 23:52:45 CEST 2025 -->
8484

8585
<!--te-->
8686

@@ -218,7 +218,9 @@ Schedule::command('media-library:regenerate --only-missing')
218218

219219
## Page management
220220

221-
The package provides a comprehensive page management system built on flexible content blocks.
221+
The package provides a comprehensive page management system built on flexible content blocks.
222+
223+
<img src="documentation/screenshots/page-blocks.png" alt="Page blocks screenshot" width="100%" />
222224

223225
### Features
224226

@@ -236,7 +238,7 @@ The package provides a comprehensive page management system built on flexible co
236238

237239
### Creating Pages
238240

239-
TODO screenshot
241+
<img src="documentation/screenshots/page-general.png" alt="Page general tab screenshot" width="100%" />
240242

241243
Create new pages through the Filament admin interface with a multi-tab form:
242244

@@ -250,7 +252,7 @@ Pages use automatic slug generation from the title but can be manually overridde
250252

251253
### Page Hierarchy
252254

253-
TODO screenshot
255+
<img src="documentation/screenshots/page-hierarchy.png" alt="Page tree screenshot" width="100%" />
254256

255257
Create organized page structures with automatic URL generation:
256258

@@ -322,6 +324,8 @@ Menus support multiple types of links and can be easily styled with custom templ
322324
- **Icon support** - Optional icons for menu items (basic implementation currently)
323325
- **Dynamic labels** - Use model titles or custom labels for linked content
324326

327+
<img src="documentation/screenshots/menu.png" alt="Menu builder" width="100%" />
328+
325329
### Adding a menu to Blade
326330

327331
The package includes a `default` built-in menu style which is developed in a generic way so that you can tweak its styling,
@@ -554,7 +558,7 @@ Create and manage tags through the Filament admin interface:
554558
- **SEO Settings** - Meta descriptions and tags can be enabled to have an SEO tag page
555559
- **Visual Identity** - Colors and icons for better organization
556560

557-
TODO screenshot
561+
<img src="documentation/screenshots/tags.png" alt="Tag management" width="100%" />
558562

559563
### Tag Types
560564

@@ -625,16 +629,6 @@ For detailed configuration options and examples, see the [configuration document
625629

626630
If you want to further customise or extend the functionality, have a look [at the options](documentation/extending-and-customisation.md).
627631

628-
## TODO's
629-
630-
check:
631-
- do install docs work
632-
- Seppe: tailwind config complete? do we need to add flexible content blocks styling?
633-
- Seppe: menu components ok?
634-
635-
release:
636-
- Kristof: screenshots + banner + packagist + slack + filament plugin store
637-
638632
## Future work
639633

640634
- Caching of the menu data structure.
@@ -644,6 +638,7 @@ release:
644638
- FAQ model, resource and flexible blocks
645639
- A component to put on the pages with a quick link to edit this page in Filament
646640
- A trait for page indexing in Laravel Scout
641+
- Improve installation & setup: create an install command
647642

648643
## Development
649644

documentation/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ In this document, we explain all settings available in the [filament-flexible-co
3030
* [Custom Menu Styles](#custom-menu-styles)
3131

3232
<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
33-
<!-- Added by: sten, at: Thu Sep 11 00:02:19 CEST 2025 -->
33+
<!-- Added by: sten, at: Mon Sep 29 23:52:45 CEST 2025 -->
3434

3535
<!--te-->
3636

documentation/extending-and-customisation.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ In this document, we will explain how you can change behaviour or extend functio
3131
* [Advanced Extensions](#advanced-extensions)
3232

3333
<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
34-
<!-- Added by: sten, at: Thu Sep 11 00:02:20 CEST 2025 -->
34+
<!-- Added by: sten, at: Mon Sep 29 23:52:46 CEST 2025 -->
3535

3636
<!--te-->
3737

documentation/frontend.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This document covers frontend templating, theme customization, and available Bla
2525
* [Accessibility](#accessibility)
2626

2727
<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
28-
<!-- Added by: sten, at: Thu Sep 11 00:02:20 CEST 2025 -->
28+
<!-- Added by: sten, at: Mon Sep 29 23:52:46 CEST 2025 -->
2929

3030
<!--te-->
3131

documentation/screenshots/menu.png

109 KB
Loading
550 KB
Loading
724 KB
Loading
86.6 KB
Loading

documentation/screenshots/tags.png

73.8 KB
Loading

0 commit comments

Comments
 (0)