Make step 3 in Introduction doc clearer for MVC users #112
Conversation
Signed-off-by: Brian N. Millar <114314688+brian-n-millar@users.noreply.github.com>
Signed-off-by: Brian N. Millar <114314688+brian-n-millar@users.noreply.github.com>
Signed-off-by: Brian N. Millar <114314688+brian-n-millar@users.noreply.github.com>
| 'factories' => [ | ||
| MyNamespace\Command\MyCommand::class => MyNamespace\Command\MyCommandFactory::class, | ||
| ], | ||
| ], | ||
| ]; | ||
| ``` | ||
|
|
||
| > ### Container Config Identifier |
There was a problem hiding this comment.
You will get rid of the markdown issues by adding an empty line here.
Putting a newline here with > would already achieve that.
There was a problem hiding this comment.
@brian-n-millar
Unfortunately, the documentation is a bit misleading here because you do not need step 3. and 4. if you use a config provider class in your laminas-mvc module.
And this additional explanation does not really help here. There must be a clear separation for Mezzio, a laminas-mvc based application and others.
At the moment, unfortunately, I don't know what is meant by "components" either:
Integrating in Components
If you'd like to add integration with laminas-cli into your components…
https://docs.laminas.dev/laminas-cli/intro/#integrating-in-components
There are more problems on this page:
- it is called "Introduction" but contains the usage
- the installation belongs on its own page
- the steps to create a command is incomplete and should be under its own heading
- the basic usage should follow an example, including the call via the console
There was a problem hiding this comment.
I agree that the current documentation might be miss-structured but I think we should re-structure this in a dedicated issue.
Since the documentation does actually only provide details for mezzio, what would be your suggestion on how to split this into pieces without totally re-structuring the whole intro file?
boesing
added
Documentation
There was a problem hiding this comment.
LGTM.
Requested review from @froschdesign as he tends to have decent feedback on documentation.
|
@froschdesign - Whilst there are further improvements to be made to the docs, I'm about to do a release and it looks to me like this is a sound improvement regardless of other noted flaws, so I'll merge and release. Hope that's OK 🤞 Thanks @brian-n-millar |
Description
This PR is in relation to my issue #111.
Updates the Introduction to give more clarity to step 3 for MVC users.
This is my first PR to this project so apologies if I've made any mistakes.