Skip to content

Revert "Add documentation for Storefront Components"#2212

Open
Tobias Berge (tobiasberge) wants to merge 5 commits intomainfrom
revert-2182-storefront-components
Open

Revert "Add documentation for Storefront Components"#2212
Tobias Berge (tobiasberge) wants to merge 5 commits intomainfrom
revert-2182-storefront-components

Conversation

@tobiasberge
Copy link
Copy Markdown
Contributor

Reverts #2182

We'd like to to revert the docs for the component system for now.
With this change vite will be introduced as a bundler to compile component JS. It also allows adding external dependencies (node_modules) more easily for 3rd party developers.

This will result in a breaking change in the currently documented way of adding component JavaScript in the theme.json. We want to finish the JS part of the component system first. We can bring back the docs afterwards with the necessary changes. In the meantime we don't want to actively promote the current solution because it will change later.

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 reverts previously added documentation around the Storefront Components system to avoid promoting a workflow that is expected to change with the upcoming move to Vite-based bundling.

Changes:

  • Removes the Storefront Components concept page and related references from plugin/app storefront template customization guides.
  • Adjusts the theme configuration guide to remove component-related/script guidance that is expected to change.
  • Cleans up the spelling wordlist by removing component-doc-specific terms.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file
File Description
guides/plugins/themes/theme-configuration.md Removes/reshuffles sections related to theme configuration (including script/component-related guidance).
guides/plugins/plugins/storefront/customize-templates.md Removes the “Storefront Components” section/link.
guides/plugins/apps/storefront/customize-templates.md Removes the “Storefront Components” section/link.
concepts/framework/storefront-components.md Deletes the Storefront Components documentation page.
.wordlist.txt Removes now-unused terms that were primarily needed for the deleted docs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

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>
Copy link
Copy Markdown
Contributor

@Isengo1989 Micha Hobert (Isengo1989) left a comment

Choose a reason for hiding this comment

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

Thx for the PR Tobias Berge (@tobiasberge) 👍

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.

4 participants