laravel-beyond icon indicating copy to clipboard operation
laravel-beyond copied to clipboard

Document what every type is good for

Open Wulfheart opened this issue 3 years ago • 11 comments

I think it would be really helpful to document what each type of action which can be generated is good for.

Wulfheart avatar May 18 '22 07:05 Wulfheart

Thanks for your suggestion. Maybe you want to support us with a pull request?

regnerisch avatar May 18 '22 07:05 regnerisch

@Wulfheart Does the current README feel more descriptive to you?

alexanderkroneis avatar Aug 10 '22 07:08 alexanderkroneis

@alexgaal Yes, it does. @regnerisch I don't know your goals. If you just develop this for your own benefit then I think the docs are complete. However, I believe that this package has become something more than an auxiliary package to a book. That's why I think that a more thorough explanation of the concepts is needed. Good documentation is in my opinion key to let the package blow up.

Wulfheart avatar Sep 11 '22 15:09 Wulfheart

You are right, this package is not longer just a package for my own usage. As I already said: Feel free to support us with a PR and better docs. Even a little input how you would expect the docs could help us :)

regnerisch avatar Sep 14 '22 10:09 regnerisch

I am going to write a draft.

Wulfheart avatar Sep 21 '22 07:09 Wulfheart

@Wulfheart do you want to improve the documentation any further? As we are currently developing v7, it can't be a better time to provide better docs ;)

regnerisch avatar Mar 19 '23 12:03 regnerisch

I guess I will add an annotation where each command creates something in (App/Domain/Infrastructure). This would help me really much as I am always asking myself where it is generated.

Wulfheart avatar Aug 30 '23 20:08 Wulfheart

What do you prefer? A structure like this:

## Usage

### Commands

#### App

#### Domain

##### `beyond:make:action`

This command will create a new action class inside your domain.

```bash
php artisan beyond:make:action Users.CreateUserAction
```

###### Options

| Name       | Description                                        |
|------------|----------------------------------------------------|
| `--force`  | Create the class even if the action already exists |

---

Or something like #### beyond:make:action [Domain]? can contribute both if you want to.

Wulfheart avatar Aug 30 '23 20:08 Wulfheart

It's your decision :)

regnerisch avatar Sep 01 '23 08:09 regnerisch

So no preferences?

Wulfheart avatar Sep 01 '23 09:09 Wulfheart

We will use the Github wiki for out documentation: https://github.com/AkrilliA/laravel-beyond/wiki

Edit: No we will use https://akrillia.github.io/laravel-beyond/#/ for documentation :)

regnerisch avatar Nov 30 '23 08:11 regnerisch

As we (again) changed how v7 work, we also again changed the documentation, take a look at /docs folder inside the main branch. We plan to release v7 next month.

regnerisch avatar May 25 '24 08:05 regnerisch