chore: adds CLI to install docs#2205
Open
somethings (lasomethingsomething) wants to merge 111 commits intomainfrom
Open
chore: adds CLI to install docs#2205somethings (lasomethingsomething) wants to merge 111 commits intomainfrom
somethings (lasomethingsomething) wants to merge 111 commits intomainfrom
Conversation
Contributor
|
|
Copilot started reviewing on behalf of
somethings (lasomethingsomething)
March 25, 2026 14:00
View session
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the developer docs to make the Shopware CLI the primary installation path, reorganizes legacy installation content, and expands/reshapes extension and API documentation (notably apps and “working with APIs”).
Changes:
- Make CLI-based installation the recommended path; move Docker setup under “Legacy setups” and add redirects.
- Restructure app documentation into clearer paths (Admin UI–only vs backend/registration) and update cross-links accordingly.
- Add/expand API quickstart docs and reorganize development onboarding/troubleshooting content.
Reviewed changes
Copilot reviewed 46 out of 46 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| resources/references/app-reference/manifest-reference.md | Updates app manifest reference links to point at the new app registration/setup guide. |
| products/cli/installation.md | Adjusts nav ordering and refines wording for “Other Installation Options”. |
| products/cli/index.md | Reorders nav, tweaks intro text, and reshuffles the quickstart install tabs. |
| products/cli/command-types.md | New page extracting “command scopes” + refactoring overview from the CLI index. |
| guides/upgrades-migrations/index.md | Adds an “upgrade impact in real projects” info box. |
| guides/plugins/plugins/plugin-fundamentals/use-plugin-configuration.md | Refactors into tabs for PHP/Admin JS/Storefront configuration access. |
| guides/plugins/plugins/plugin-fundamentals/index.md | Title casing + minor formatting cleanup. |
| guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md | Improves intro, resource links, and wraps the full example in a collapsible block. |
| guides/plugins/plugins/plugin-base-guide.md | Reworks prerequisites and adds a generated-structure summary + config.xml pointers. |
| guides/plugins/plugins/index.md | Replaces list with a task-oriented table linking to key plugin guides. |
| guides/plugins/plugins/bundle.md | Clarifies bundle vs plugin behavior and normalizes wording/capitalization. |
| guides/plugins/apps/webhook.md | Updates registration/setup cross-links and nav ordering. |
| guides/plugins/apps/tax-provider.md | Title casing and nav repositioning. |
| guides/plugins/apps/shipping-methods.md | Title casing and nav repositioning. |
| guides/plugins/apps/payment.md | Nav repositioning. |
| guides/plugins/apps/index.md | Adds “Start here / Build path by use case” and contextual architecture links. |
| guides/plugins/apps/create-admin-extension.md | New guide for building an Admin UI app locally without a backend. |
| guides/plugins/apps/configuration.md | Nav repositioning. |
| guides/plugins/apps/clientside-to-app-backend.md | Renames/repositions page (title + nav) for client-side backend comms. |
| guides/plugins/apps/app-signature-verification.md | Nav repositioning (minor formatting). |
| guides/plugins/apps/app-sdks/symfony-bundle/index.md | Updates link to the new app registration/setup guide anchor. |
| guides/plugins/apps/app-scripts/data-loading.md | Updates permissions cross-link to new app registration/setup guide. |
| guides/plugins/apps/app-registration-setup.md | New comprehensive guide for app registration/setup, permissions, validation, and URL changes. |
| guides/plugins/apps/app-base-guide.md | Splits out backend-specific content; focuses on shared foundation + next-step routing. |
| guides/plugins/apps/administration/add-custom-modules.md | Updates registration/setup cross-link to new guide. |
| guides/plugins/apps/administration/add-custom-action-button.md | Updates webhook/setup links to new locations. |
| guides/installation/system-requirements.md | Adjusts nav ordering and updates “next step” link to installation overview. |
| guides/installation/start-developing.md | Removes the old installation “start developing” page (content moved). |
| guides/installation/project-overview.md | Title casing and minor formatting cleanup. |
| guides/installation/legacy-setups/symfony-cli-setup.md | Fixes Docker link target and updates frontend build/watch reference link. |
| guides/installation/legacy-setups/index.md | Renames legacy section and adds “legacy installation methods” subsection. |
| guides/installation/legacy-setups/docker-setup.md | Adds a short Docker setup framing paragraph. |
| guides/installation/index.md | Rewrites installation overview to center on Shopware CLI flow (Docker fallback referenced). |
| guides/development/troubleshooting/index.md | Expands troubleshooting with DB/API and debugging content. |
| guides/development/start-developing.md | New development onboarding page (moved from installation section). |
| guides/development/integrations-api/search-criteria.md | Nav reorder. |
| guides/development/integrations-api/request-headers.md | Nav reorder. |
| guides/development/integrations-api/index.md | Rewrites “Working with APIs” into a practical API quickstart. |
| guides/development/integrations-api/generated-reference.md | Nav reorder. |
| guides/development/integrations-api/auth-api-requests.md | New follow-up guide for auth patterns and troubleshooting API requests. |
| guides/development/index.md | Reframes Development landing page and links to new onboarding + key sections. |
| guides/development/extensions/index.md | Adds clearer extension-type taxonomy (plugins/static plugins/bundles/apps/themes). |
| guides/development/extensions/frontend.md | New page documenting build/watch commands for Storefront + Administration. |
| guides/development/extensions/architecture/index.md | Nav position tweak. |
| concepts/extensions/apps-concept.md | Updates registration workflow link to new app registration/setup guide. |
| .gitbook.yaml | Updates redirects for moved Docker guide and moved “start developing” page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
guides/plugins/plugins/plugin-fundamentals/add-plugin-configuration.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Su (sushmangupta)
requested changes
Mar 27, 2026
Soner (shyim)
requested changes
Mar 30, 2026
Co-authored-by: Soner <s.sayakci@shopware.com>
Co-authored-by: Soner <s.sayakci@shopware.com>
Contributor
Author
|
Soner (@shyim) If you're done reviewing please give a +1 and we can push to Su (@sushmangupta) (and go hollywood with CLI install) |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR: