chore: updates plugin and Shopware 6 Toolbox plugin docs - #2420
chore: updates plugin and Shopware 6 Toolbox plugin docs#2420somethings (lasomethingsomething) wants to merge 16 commits into
Conversation
Developer Docs healthcheckStatus: Completed with |
📊 Documentation Impact Analyzer
Reasons
|
There was a problem hiding this comment.
Pull request overview
Updates Shopware 6 plugin development documentation to better explain scaffolding and IDE tooling, and to clarify when to prefer service decoration vs extension points in real-world projects.
Changes:
- Expanded service decoration guidance with practical pitfalls for multi-extension projects and links to related tooling/docs.
- Updated plugin creation docs to reflect generator options, version caveats, and IDE-based generation via the Shopware 6 Toolbox.
- Significantly expanded the Shopware 6 Toolbox documentation (generators, intentions, inspections, navigation, project setup, customization, installation notes).
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| guides/plugins/plugins/services/adjusting-service.md | Adds a new section on decoration chains, signature pitfalls, and safer alternatives via extension points. |
| guides/plugins/plugins/plugin-base-guide.md | Adds a tooling section pointing readers to both CLI scaffolding and IDE generators. |
| guides/plugins/plugins/framework/extension/extension-vs-events.md | Adds a comparison section explaining how extension points differ from service decoration. |
| guides/plugins/plugins/creating-plugins.md | Expands CLI scaffolding docs with option matrix, version caveats, and IDE alternative guidance. |
| guides/development/tooling/shopware-toolbox.md | Refreshes and expands Toolbox docs (features, generators, intentions, inspections, navigation, setup/customization). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This comment was marked as low quality.
This comment was marked as low quality.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This comment was marked as low quality.
This comment was marked as low quality.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
This comment was marked as low quality.
Bojan Rajh (bojanrajh)
left a comment
There was a problem hiding this comment.
A bit weird to see mixed 85-char, multi-sentence, and single-sentence (not in this diff) per line writing style. Although the visual result for end-users will be the same, it would be nice if we'd define preferred style at least - https://developer.shopware.com/docs/resources/guidelines/documentation-guidelines/04-fonts-and-formats/01-text.html Micha Hobert (@Isengo1989) Su (@sushmangupta)
We had that talk/discussion already with multiple contributors, internal and external. We choose the "smallest friction possible", to get PRs going, and since there is no issue in the frontend, we kept it that way. I am open for discussion tho, feel free to create a ticket in our space. |
Micha Hobert (Isengo1989)
left a comment
There was a problem hiding this comment.
Thanks for the PR somethings (@lasomethingsomething) 👍
Summary
Changes in five files, with facts checked against shopware/shopware (6.7.13.x + trunk) and the Toolbox plugin.xml, along with meeting notes.
shopware-toolbox.md: renamed to "Shopware 6 Toolbox" in nav, expanded from the plugin's actual plugin.xml:
creating-plugins.md: Added: what is always generated, version-tied scaffolding caveat, cache:clear note, Toolbox alternative, and why only shopware-platform-plugin is discovered (PluginFinder::COMPOSER_TYPE).
adjusting-service.md: new Decoration in a shared codebase: chains nest and each link must delegate or it silently eats other plugins' behavior; how to list the chain (Navigate → Implementations, debug:container --show-arguments); signature changes force a plugin major per Shopware major; type-hint the abstract class; prefer extension points; addExtension() data ships in API payloads.
extension-vs-events.md: Extension Points vs Service Decoration comparison, the "why extensions exist" the transcript covered (page compared extensions to events but never to decoration).
plugin-base-guide.md: Tooling section linking both scaffolding paths.
Checklist
PageRefreferences where relevant..gitbook.yamlif pages were moved, renamed, or deleted..wordlist.txt(and sorted it) if spellcheck flags new legitimate terms.Notes