Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document what every type is good for #34

Closed
Wulfheart opened this issue May 18, 2022 · 12 comments
Closed

Document what every type is good for #34

Wulfheart opened this issue May 18, 2022 · 12 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@Wulfheart
Copy link
Contributor

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

@regnerisch regnerisch added documentation Improvements or additions to documentation good first issue Good for newcomers labels May 18, 2022
@regnerisch
Copy link
Collaborator

regnerisch commented May 18, 2022

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

@alexanderkroneis
Copy link
Collaborator

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

@Wulfheart
Copy link
Contributor Author

Wulfheart commented Sep 11, 2022

@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.

@regnerisch
Copy link
Collaborator

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 :)

@Wulfheart
Copy link
Contributor Author

I am going to write a draft.

@regnerisch
Copy link
Collaborator

@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 ;)

@Wulfheart
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

@regnerisch
Copy link
Collaborator

It's your decision :)

@Wulfheart
Copy link
Contributor Author

So no preferences?

@regnerisch
Copy link
Collaborator

regnerisch commented Nov 30, 2023

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 regnerisch added this to the v7.0.0 milestone Nov 30, 2023
@regnerisch
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants