Skip to content

chore: adds CLI to install docs#2205

Open
somethings (lasomethingsomething) wants to merge 111 commits intomainfrom
changes-mar17
Open

chore: adds CLI to install docs#2205
somethings (lasomethingsomething) wants to merge 111 commits intomainfrom
changes-mar17

Conversation

@lasomethingsomething
Copy link
Copy Markdown
Contributor

This PR:

  • adds the Shopware CLI install to the main installation, with steps
  • Moves the Docker setup to "Legacy setups"
  • adds pages around working with APIs
  • splits app guide into apps requiring backend and Admin UI apps (the latter based on a recent successful run-through)
  • adds a sequence/user flow to the apps/index.md

Copilot AI review requested due to automatic review settings March 25, 2026 13:59
@github-actions
Copy link
Copy Markdown
Contributor

⚠️ Moved markdown files detected. Please ensure redirects are updated in .gitbook.yaml file.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor

@sushmangupta Su (sushmangupta) left a comment

Choose a reason for hiding this comment

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

@lasomethingsomething
Copy link
Copy Markdown
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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants