Merge pull request #1520 from hydephp/update-ui-kit-documentation

Update UI kit documentation
hydephp · Feb 2, 2024 · b7eccd4 · b7eccd4
2 parents 313ade1 + 4e3e70e
commit b7eccd4
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 28 deletions.
diff --git a/packages/ui-kit/docs/_pages/examples/newsletter-signup-example.blade.php b/packages/ui-kit/docs/_pages/examples/newsletter-signup-example.blade.php
diff --git a/packages/ui-kit/docs/documentation.md b/packages/ui-kit/docs/documentation.md
@@ -8,14 +8,18 @@ The HydePHP UI Kit is a collection of minimalistic and un-opinionated TailwindCS
 indented to be used with HydePHP. Note that these components may require CSS classes not present in the bundled app.css
 file and that you may need to recompile the CSS file using the included Laravel Mix configuration.
 
-## Preface
+## Screenshot
 
-Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.
+Here are some of the components you can use to build your next project! As you can see, all components support both light and dark mode out of the box, just like the rest of HydePHP.
 
->info Tip: Most components allow you to pass any additional HTML attributes to the element!
+![Components Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/header-large-min.png)
 
 ## Components
 
+Please make sure you're familiar with [Laravel Blade](https://laravel.com/docs/blade) before using the HydePHP UI Kit.
+
+>info Tip: Most components allow you to pass any additional HTML attributes to the element!
+
 ### Buttons
 
 #### Primary
@@ -156,3 +160,5 @@ You can get surprisingly far when you combine the components. Take this newslett
     </x-slot>
 </x-hyde-ui::card>
 ```
+
+![Newsletter Screenshot](https://raw.githubusercontent.com/hydephp/ui-kit/art/newsletter-signup-example-min.png)