feat: add docs

AkrilliA · Dec 1, 2023 · f458e96 · f458e96
1 parent e538300
commit f458e96
Show file tree

Hide file tree

Showing 12 changed files with 118 additions and 6 deletions.
diff --git a/docs/.nojekyll b/docs/.nojekyll
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,13 @@
+# Laravel Beyond
+
+*This package is inspired by "[Laravel Beyond CRUD](https://spatie.be/products/laravel-beyond-crud)" from Spatie
+and "[Modularising the Monolith](https://www.youtube.com/watch?v=0Rq-yHAwYjQ&t=4129s)" from Ryuta Hamasaki.*
+
+
+This package will help you with `beyond:make` commands to easily create classes inside your "Laravel Beyond CRUD"
+inspired application.
+We try to implement commands as near as possible on their original `make` counterparts.
+
+In version 7 we completely changed the way how Laravel Beyond works. We now do no longer change Laravels default
+directory structure, instead we place the DDD structure inside a separate `modules` directory. This ensures
+compatibility with any other (Laravel related) package. 
diff --git a/docs/_navbar.md b/docs/_navbar.md
@@ -0,0 +1,2 @@
+* Translations
+  * [:de: Deutsch](de/)
diff --git a/docs/_sidebar.md b/docs/_sidebar.md
@@ -0,0 +1,5 @@
+* Getting Started
+  * [Installation](installation.md)
+  * [Upgrade Guide](upgrade.md)
+* Commands
+  * [MakeActionCommand](make-action-command.md)
diff --git a/docs/de/README.md b/docs/de/README.md
@@ -0,0 +1,13 @@
+# Laravel Beyond
+
+*Dieses Paket ist inspiriert von "[Laravel Beyond CRUD](https://spatie.be/products/laravel-beyond-crud)" von Spatie
+und "[Modularising the Monolith](https://www.youtube.com/watch?v=0Rq-yHAwYjQ&t=4129s)" von Ryuta Hamasaki.
+
+
+Dieses Paket wird Ihnen mit `beyond:make`-Befehlen helfen, auf einfache Weise Klassen innerhalb Ihrer "Laravel Beyond CRUD"
+inspirierten Anwendung zu erstellen.
+Wir versuchen, die Befehle so nah wie möglich an ihre ursprünglichen `make`-Pendants zu implementieren.
+
+In Version 7 haben wir die Arbeitsweise von Laravel Beyond komplett geändert. Wir ändern jetzt nicht mehr Laravels Standard
+Verzeichnisstruktur, stattdessen platzieren wir die DDD-Struktur in einem separaten `modules`-Verzeichnis. Dies gewährleistet
+Kompatibilität mit allen anderen (Laravel-bezogenen) Paketen.
diff --git a/docs/de/_navbar.md b/docs/de/_navbar.md
@@ -0,0 +1,2 @@
+* Translations
+  * [:gb: English](/)
diff --git a/docs/de/_sidebar.md b/docs/de/_sidebar.md
@@ -0,0 +1,5 @@
+* Loslegen
+  * [Installation](de/installation.md)
+  * [Update Anleitung](de/upgrade.md)
+* Befehle
+  * [MakeActionCommand](de/make-action-command.md)
diff --git a/docs/de/make-action-command.md b/docs/de/make-action-command.md
@@ -0,0 +1,20 @@
+# MakeActionCommand
+Erstellt eine neue Aktionsklasse innerhalb des angegebenen Moduls.
+
+> Aktionen werden in `modules/{Module}/Domain/Actions` gespeichert
+
+## Anwenden
+```bash
+php artisan beyond:make:action User.Admin/CreateUserAction
+php artisan beyond:make:action User.CreateUserAction
+```
+
+### Befehl
+`beyond:make:action`
+
+### Optionen
+| Name    | Kurz | Beschreibung                         | Beispiel |
+|---------|------|--------------------------------------|----------|
+| --force |      | Überschreibt eine existierende Datei |          |
+
+
diff --git a/docs/index.html b/docs/index.html
@@ -0,0 +1,32 @@
+<!-- index.html -->
+
+<!DOCTYPE html>
+<html>
+<head>
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
+    <meta name="viewport" content="width=device-width,initial-scale=1" />
+    <meta charset="UTF-8" />
+    <link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css"/>
+</head>
+<body>
+<div id="app"></div>
+<script>
+    window.$docsify = {
+        loadNavbar: true,
+        loadSidebar: true,
+        subMaxLevel: 2,
+        search: 'auto',
+        name: 'Laravel Beyond',
+        nameLink: {
+            '/de/': '#/de/',
+            '/': '#/',
+        },
+    }
+</script>
+<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
+<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-bash.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-json.min.js"></script>
+<script src="//cdn.jsdelivr.net/npm/prismjs@1/components/prism-php.min.js"></script>
+</body>
+</html>
diff --git a/docs/installation.md b/docs/installation.md
@@ -0,0 +1,6 @@
+# Installation
+It's recommended to install `laravel-beyond` with [composer](https://composer.org).
+
+```bash
+composer require --dev akrillia/laravel-beyond
+```
diff --git a/docs/make-action-command.md b/docs/make-action-command.md
@@ -0,0 +1,20 @@
+# MakeActionCommand
+Creates a new action class inside the given module.
+
+> Actions will be placed in `modules/{Module}/Domain/Actions`
+
+## Usage
+```bash
+php artisan beyond:make:action User.Admin/CreateUserAction
+php artisan beyond:make:action User.CreateUserAction
+```
+
+### Command
+`beyond:make:action`
+
+### Flags
+| Name    | Short | Description              | Example |
+|---------|-------|--------------------------|---------|
+| --force |       | Overwrites existing file |         |
+
+
diff --git a/UPGRADE.md → docs/upgrade.md b/UPGRADE.md → docs/upgrade.md
@@ -1,15 +1,9 @@
 # Upgrade Guide
-
-- [Upgrade to 7.x from 6.x](#upgrade-to-7x-from-6x)
-- [Upgrade to 5.x from 4.x](#upgrade-to-5x-from-4x)
-- [Upgrade to 4.x from 3.x](#upgrade-to-4x-from-3x)
-
 ## Upgrade to 7.x from 6.x
 ### Directory Structure
 ### Dropped Commands
 We decided to drop following Commands:
 
-- `beyond:make:command`
 - `beyond:make:route`
 - `beyond:make:trait`
 - `beyond:setup`