[TwigComponent] Add documentation for MakerBundle installation #1923
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
docs: Document a quick way to get the component boilerplate in.
smnandre
reviewed
Jun 19, 2024
| @@ -72,6 +94,8 @@ file to control the template directory for your components: | |||
| # Namespace & directory for components | |||
| App\Twig\Components\: 'components/' | |||
|
|
|||
| That's it! We're ready to go! | |||
There was a problem hiding this comment.
I prefer the way it was before. For most of new users, composer require will be enough.
smnandre
reviewed
Jun 19, 2024
|
|
||
| Success! | ||
|
|
||
| This will also setup the config. |
There was a problem hiding this comment.
What do you mean here ? How does the maker bundle set the local config ?
smnandre
reviewed
Jun 19, 2024
Comment on lines
+80
to
+81
| Similarly, to make a `live component`_, enter ``yes`` when prompted whether | ||
| to make this a live component. |
There was a problem hiding this comment.
I don't think we should talk about LiveComponent that early in the page.
|
Thank you for the suggestion, @techSolstice. My primary concern with the current implementation is that using the maker is not strictly related to “installation.” If we want to document it, I suggest we create a dedicated section, similar to how it’s done for controllers: Symfony Documentation - Generating Controllers. Would you be able to adapt this PR in that direction? |
smnandre
added
docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
docs: Add documentation for a quick way to get the component boilerplate in.