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

[make:twig-component] docs: Adding twig component examples and references to sister documentation #1572

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

techSolstice
Copy link

Addresses symfony/ux#480

Copy link
Collaborator

@jrushlow jrushlow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Howdy @techSolstice - This is awesome but I think @kbond meant for references to be added to https://github.com/symfony/ux/blob/2.x/src/TwigComponent/doc/index.rst

I'm not opposed to adding new documentation to MakerBundles docs, but typically we only do that for things that affect MakerBundle itself. E.g. global configuration. For now, I'm not sure that we should add this here seeing as we don't have doc's for other specific maker commands.

I'll keep this open for the time being and chew on it for a bit - this might be something we should be doing, albeit in a more limited fashion. E.g.

make:twig-component - Generates a TwigComponent(link to docs)
    Arguments:
        "name" - the name of the twig component, e.g. MyTwigComponent
   Options:
        -q   Quiets the output
        -v   Verbose

If we end up doing this, I'd want to automate this process so we can just pull each commands name / description & the arguments / options from the code base directly. Otherwise these docs would probably be forgotten about.

cc @kbond @javiereguiluz

@jrushlow jrushlow added Status: Waiting Feedback Needs feedback from the author Minor Minor Enhancement labels Jun 15, 2024
@techSolstice
Copy link
Author

@jrushlow Created symfony/ux#1923 for now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Minor Minor Enhancement Status: Waiting Feedback Needs feedback from the author
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants