[Toolkit] Add support for documenting props/blocks API #3154
Conversation
This file contains hidden or 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
Kocal
force-pushed
the
2950-toolkit-props-api-docs-bis
branch
3 times, most recently
from
e6d8290 to
ada069d
Compare
carsonbot
added
Feature
There was a problem hiding this comment.
Pull Request Overview
This PR adds automatic API reference documentation generation for Twig components. The system parses special comment annotations (@prop and @block) in component templates to generate API documentation tables showing available props and blocks.
- Implements
renderApiReference()method that extracts API annotations from Twig templates using regex patterns - Integrates API reference section into component documentation pages
- Adds CommonMark table extension support with responsive styling
Reviewed Changes
Copilot reviewed 77 out of 78 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| ux.symfony.com/src/Service/Toolkit/ToolkitService.php | Adds renderApiReference() method to parse @prop and @block annotations from Twig files and generate markdown tables |
| ux.symfony.com/src/Twig/Components/Toolkit/ComponentDoc.php | Integrates API reference generation into component documentation content |
| ux.symfony.com/src/Service/CommonMark/ConverterFactory.php | Adds TableExtension and DefaultAttributesExtension to support markdown tables with responsive wrapping |
| ux.symfony.com/assets/styles/components/_Wysiwyg.scss | Adds styling for responsive table containers |
| ux.symfony.com/composer.json | Adds symfony/string dependency |
| src/Toolkit/kits/shadcn//templates/components/.html.twig | Adds @prop and @block annotations to component templates for API documentation |
| src/Toolkit/kits/shadcn/*/EXAMPLES.md | Updates examples to reflect prop name changes and add new examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| @@ -1,3 +1,5 @@ | |||
| {# @prop variant 'default'|'desctructive' The variant, default to `default` #} | |||
There was a problem hiding this comment.
Corrected spelling of 'desctructive' to 'destructive'.
Suggested change
| {# @prop variant 'default'|'desctructive' The variant, default to `default` #} | |
| {# @prop variant 'default'|'destructive' The variant, default to `default` #} |
| ``` | ||
|
|
||
| ## With a 1 / 1 aspect ratio | ||
| ## With 2 / 3 aspect ratio |
There was a problem hiding this comment.
Extra space in the heading '2 / 3 aspect ratio' (double space before 'aspect'). Should be single space.
Suggested change
| ## With 2 / 3 aspect ratio | |
| ## With 2 / 3 aspect ratio |
Kocal
force-pushed
the
2950-toolkit-props-api-docs-bis
branch
from
ada069d to
133943b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Props and blocks now render like that:
I also updated/fixed some examples or components