Feedback: CMS Component Guide

[OliverSkroblin]

Hello,

thank you for providing the guide on how to create a CMS component. While following the instructions, I noticed a few areas that could be improved to make the process easier and more beginner-friendly. Here’s some constructive feedback:

1. Starting with the Admin Preview:
   Beginning the guide with creating a preview element in the admin can be a bit confusing for someone who just wants to create a new CMS component. It might be more intuitive to start with the basic functionality—creating a component with configuration options and rendering it in the storefront—and leave the admin preview for later.

2. Simplifying File Paths:
   Copying the file paths from the code snippets is a bit cumbersome. It would be great if the guide could make this process simpler, perhaps with clearer instructions or more concise file structure overviews.

3. Focus on the Core Functionality First:
   The guide could focus more on the essential steps to create a functional CMS component, such as adding a configuration and rendering it in the storefront. Additional features like admin previews, styling, or extended functionality could come as separate sections afterwards.

4. Downloadable Plugin Example:
   Providing a downloadable example plugin that includes all the necessary files and configurations would be a huge help. This would allow developers to see the complete picture and quickly test or modify the functionality.

5. Full Code Examples:
   At the end of the guide, having complete, ready-to-use code examples for all files would save a lot of time. Copy-pasting an entire structure is much easier when dealing with a lot of boilerplate for a seemingly simple component.

6. Reduce Lengthy Explanations:
   While the detailed explanations are helpful, they can feel overwhelming at times. Consider adding short, skimmable lists or summaries for file purposes, directory structures, or other repetitive information. This would allow readers to focus on the steps that matter most to them.

Thank you for considering this feedback! I really appreciate the effort that goes into writing these guides and hope these suggestions help make the process even smoother for developers.

Best regards,
Oliver Skroblin

[sushmangupta]

Hi @OliverSkroblin ,
Thanks for sharing the feedback. I have created an internal ticket as a reminder to work on it : https://shopware.atlassian.net/browse/DX-626