Document Twig block versioning in Shopware Toolbox - #2413
Conversation
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Developer Docs healthcheckStatus: Completed with |
📊 Documentation Impact Analyzer
Reasons
|
There was a problem hiding this comment.
Pull request overview
This PR extends the Shopware Toolbox documentation to explain the Twig block versioning feature of the Shopware PHPStorm plugin, including the required comment format and how to apply it across a project.
Changes:
- Added a “Twig block versioning” section explaining why the feature exists and how it works.
- Documented the
shopware-blockcomment format with an example. - Added documentation for related inspections, intentions, and the “Inspect Code” workflow to bulk-add versioning comments.
Comments suppressed due to low confidence (1)
guides/development/tooling/shopware-toolbox.md:59
- Table cells contain multi-sentence text that ends with periods. The documentation guidelines recommend not ending table sentences/cells with punctuation. Rephrase these cells so they end without punctuation (and ideally keep each cell to a single sentence).
| The upstream block has changed | Yes | The recorded hash no longer matches the upstream block. Check that your override is still correct. |
| The upstream block has been removed | Yes | The block no longer exists upstream. Check that your override is still needed. |
| Twig block is deprecated | Yes | The upstream block is marked as deprecated and will be removed in a future version. |
| Shopware versioning block comment is missing | No | A block override has no versioning comment yet. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
Su (@sushmangupta) Micha Hobert (@Isengo1989) Heya, could one of you give this a quick look? |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
📊 Documentation Impact Analyzer
Reasons
|
1 similar comment
📊 Documentation Impact Analyzer
Reasons
|
Summary
{# shopware-block: <hash>@<version> #}comment format with an example, the four related inspections and their defaults, the two intentions, and the Inspect Code workflow to add versioning comments to a whole project.Related links
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted. (No pages moved.).wordlist.txt(and sorted it) if spellcheck flags new legitimate terms. (No new terms; SHA and macOS are already listed.)Notes
Inspection display names, default states, and the comment format were verified against the plugin source (plugin.xml and TwigUtil on main), not only the blog post. Markdown lint (avtodev/markdown-lint with the repo config) passes for the changed file.
🤖 Generated with Claude Code