Updated docs

Author: andrey-helldar

docs/getting-started/helpers/artisan.md

@@ -1 +1,17 @@
 # Artisan Command
+
+Quite often, when working with actions, it becomes necessary to run one or another console command, and each time you have to write the following code:
+
+```php
+use DragonCode\LaravelActions\Action;
+
+return new class () extends Action
+{
+    public function __invoke(): void
+    {
+        $this->artisan('some_command', [
+            // parameters
+        ]);
+    }
+};
+```

docs/getting-started/helpers/events.md

@@ -1 +1,51 @@
 # Events
+
+You can also handle events when executing actions:
+
+```
+DragonCode\LaravelActions\Events\ActionStarted
+DragonCode\LaravelActions\Events\ActionEnded
+DragonCode\LaravelActions\Events\ActionFailed
+DragonCode\LaravelActions\Events\NoPendingActions
+```
+
+If there are no action files to execute, the `NoPendingActions` event will be sent.
+
+In other cases, the `ActionStarted` event will be sent before processing starts, and the `ActionEnded` event will be sent after processing.
+
+For example:
+
+```php
+namespace App\Providers;
+
+use App\Listeners\SomeActionsListener;
+use DragonCode\LaravelActions\Events\ActionEnded;
+use DragonCode\LaravelActions\Events\ActionStarted;
+use DragonCode\LaravelActions\Events\NoPendingActions;
+use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
+
+class EventServiceProvider extends ServiceProvider
+{
+    protected $listen = [
+        ActionStarted::class    => [SomeActionsListener::class],
+        ActionEnded::class      => [SomeActionsListener::class],
+        ActionFailed::class     => [SomeActionsListener::class],
+        NoPendingActions::class => [SomeActionsListener::class],
+    ];
+}
+```
+
+```php
+namespace App\Listeners;
+
+use DragonCode\LaravelActions\Events\BaseEvent;
+
+class SomeActionsListener
+{
+    public function handle(BaseEvent $event): void
+    {
+        $method   = $event->method; // `up` or `down` string value
+        $isBefore = $event->before; // boolean
+    }
+}
+```

docs/getting-started/helpers/execution-status.md

@@ -0,0 +1,71 @@
+# Execution Status
+
+You can also override the `success` and `failed` methods, which are called on success or failure processing.
+
+## If Success
+
+```php
+use DragonCode\LaravelActions\Action;use Illuminate\Support\Facade\Log;
+
+return new class () extends Action
+{
+    public function up(): void
+    {
+       //
+    }
+
+    public function down(): void
+    {
+       //
+    }
+
+    public function success(): void
+    {
+       Log::info('success');
+    }
+
+    public function failed(): void
+    {
+       Log::info('failed');
+    }
+};
+```
+
+Call the `php artisan migrate:actions` command.
+
+The log file will contain two `success` entries.
+
+## If Failed
+
+```php
+use DragonCode\LaravelActions\Action;
+use Exeption;
+use Illuminate\Support\Facade\Log;
+
+return new class extends Action
+{
+    public function up(): void
+    {
+       throw new Exeption();
+    }
+
+    public function down(): void
+    {
+       throw new Exeption();
+    }
+
+    public function success(): void
+    {
+       Log::info('success');
+    }
+
+    public function failed(): void
+    {
+       Log::info('failed');
+    }
+};
+```
+
+Call the `php artisan migrate:actions` command.
+
+The log file will contain two `failed` entries.

docs/getting-started/helpers/execution-statuses.md

@@ -20,14 +20,12 @@ If you do not specify the "name" attribute, then the file name will be generated
 ```bash
 php artisan make:migration:action
 
-### When the git repository is found (`base_path('.git')` directory is exists).
-### For example, HEAD branch name is 'qwerty'.
+### When the git repository is found (`base_path('.git')` directory is exists) and HEAD branch name is 'qwerty'
 # 2022_10_11_225116_qwerty.php
 # 2022_10_11_225118_qwerty.php
 # 2022_10_11_225227_qwerty.php
 
 ### When the git repository is not found (`base_path('.git')` directory doesn't exists).
-### For example, HEAD branch name is 'qwerty'.
 # 2022_10_11_225116_auto.php
 # 2022_10_11_225118_auto.php
 # 2022_10_11_225227_auto.php

docs/getting-started/how-to-use/creating.md

@@ -0,0 +1,43 @@
+# Rolling Back Actions
+
+To roll back the latest action operation, you may use the `rollback` command. This command rolls back the last "batch" of actions, which may include multiple action files:
+
+```
+php artisan migrate:actions:rollback
+```
+
+You may roll back a limited number of actions by providing the `step` option to the rollback command. For example, the following command will roll back the last five actions:
+
+```
+php artisan migrate:actions:rollback --step=5
+```
+
+The `migrate:actions:reset` command will roll back all of your application's migrations:
+
+```
+php artisan migrate:actions:reset
+```
+
+## Roll Back & Action Using A Single Command
+
+The `migrate:actions:refresh` command will roll back all of your migrations and then execute the `migrate:actions` command. This command effectively re-creates your entire
+database:
+
+```
+php artisan migrate:actions:refresh
+```
+
+You may roll back & re-migrate a limited number of migrations by providing the `step` option to the `refresh` command. For example, the following command will roll back &
+re-migrate the last five migrations:
+
+```
+php artisan migrate:actions:refresh --step=5
+```
+
+## Drop All Actions & Rerun Actions
+
+The `migrate:actions:fresh` command will drop all actions records from the actions table and then execute the migrate command:
+
+```
+php artisan migrate:actions:fresh
+```

docs/getting-started/how-to-use/freshing.md

@@ -0,0 +1,7 @@
+# Actions Status
+
+The `migrate:actions:status` command displays the execution status of actions. In it you can see which actions were executed and which were not:
+
+```
+php artisan migrate:actions:status
+```