Skip to content

chore: updates plugin and Shopware 6 Toolbox plugin docs - #2420

Open
somethings (lasomethingsomething) wants to merge 16 commits into
mainfrom
plugin-docs
Open

chore: updates plugin and Shopware 6 Toolbox plugin docs#2420
somethings (lasomethingsomething) wants to merge 16 commits into
mainfrom
plugin-docs

Conversation

@lasomethingsomething

@lasomethingsomething somethings (lasomethingsomething) commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

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:

  • Generators table by New → Shopware Platform menu group (Plugin, PHP, App, Administration) — page was missing App generators, migration, CMS block/element
  • New Intentions section incl. Create event listener (event class → subscriber in a chosen plugin) — the transcript's headline feature, previously undocumented
  • New Inspections table: all 11 non-Twig inspections with group + severity (Store-check composer.json group was undocumented)
  • New Navigation, Project setup, and Customize the generated files (file templates for company headers — the thing core scaffolding can't do)
  • Renamed the two Twig subheadings to avoid duplicate anchors

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

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Copilot AI lite review requested due to automatic review settings August 4, 2026 11:45
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 4, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 1045c8c
Preview: https://developer-documentation-lnmlgj763-shopware-frontends.vercel.app
Workflow run: #4722

@github-actions

github-actions Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

📊 Documentation Impact Analyzer

Metric Result
Score 59
Recommendation ✅ Highly meaningful
Categories Migration, Plugins, Framework

Reasons

  • +3: PR title contains "plugin"
  • +4: 2 new headings
  • +4: Deprecation
  • +3: Plugin Development
  • +3: Plugin Development
  • +3: Code examples
  • +3: Plugin Development
  • +4: Framework
  • +3: Plugin Development
  • +4: Framework
  • +4: 2 new headings
  • +3: Plugin Development
  • +4: 2 new headings
  • +3: Plugin Development
  • +4: 2 new headings
  • +2: Code examples
  • +5: Breaking change

This score is automatically generated based on documentation impact heuristics.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Comment thread guides/plugins/plugins/creating-plugins.md Outdated
Comment thread guides/development/tooling/shopware-toolbox.md Outdated
Comment thread guides/plugins/plugins/creating-plugins.md Outdated
Comment thread guides/plugins/plugins/creating-plugins.md Outdated
@github-actions

This comment was marked as low quality.

@github-actions

This comment was marked as low quality.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

This comment was marked as low quality.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

This comment was marked as low quality.

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
@github-actions

This comment was marked as low quality.

Comment thread guides/development/tooling/shopware-toolbox.md
@github-actions

This comment was marked as low quality.

@github-actions

This comment was marked as low quality.

@github-actions

This comment was marked as low quality.

@github-actions

This comment was marked as low quality.

@bojanrajh Bojan Rajh (bojanrajh) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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)

@Isengo1989

Copy link
Copy Markdown
Contributor

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 (Micha Hobert (@Isengo1989)) Su (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.

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks for the PR somethings (@lasomethingsomething) 👍

@Isengo1989 Micha Hobert (Isengo1989) added the Improvement PR created to append/modify info in the existing article label Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants