Merchant Portal - Autocompletion / Storybook / Documentation
schoenfeld
Solution Architect Posts: 28 🧑🏻🚀 - Cadet
Any idea on how to get documentation for merchant portal webcomponents? We need:
- autocompletion/IDE Support (see screenshot - HTML Tag missing, we need it clickable and reference to its webcomponent)
- general documentation ( this seems NOT to contain all components? i.e. <web-mp-root> → see list below)
- run and build storybook locally, so we can extend and provide the customer a fully documented list of your and our components?
- can it be hosted in PaaS+ and available by a domain?
Example web components:
i.e.
- <web-mp-root>
- <web-mp-header-menu>
- <web-mp-merchant-layout-centered>
- <web-mp-form>
- […]
- <spy-user-menu>
- <spy-user-menu-item>
- <spy-user-menu-link>
- […]
- <web-spy-notification>
- <web-spy-button>
- <web-spy-datasource-dependable> (its this? and this ? But not named <spy-datasource its <web-spy-datasource)
- […]
Even if we use the search in docs.spryker.com with any of these components or topics → 0 results. So might you have some insights to each of our questions.
Example Spryker doc searches with 0 results:
2
Answers
-
We have two types of components:
- Components from our UI library, which are installed as separate dependencies (e.g., @spryker/button , etc.). This Storybook is intended for documenting these components; however, not all components may be fully covered in the documentation.
- Spryker-specific components, which were developed within the Spryker environment (e.g.,
spy-user-menu
,mp-root
, etc.). For these components, we don’t have documentation; currently, you can only review the source code. The prefix "web" indicates that this component is registered as a web component rather than an Angular component.
Additionally, we have services, and the Storybook can showcase examples of how these services work to provide better clarity (services are not the same as components). Customers configure these services at the module level in JavaScript (e.g., example link).
1
Categories
- All Categories
- 42 Getting Started & Guidelines
- 7 Getting Started in the Community
- 8 Additional Resources
- 7 Community Ideas and Feedback
- 75 Spryker News
- 919 Developer Corner
- 779 Spryker Development
- 89 Spryker Dev Environment
- 362 Spryker Releases
- 3 Oryx frontend framework
- 34 Propel ORM
- 68 Community Projects
- 3 Community Ideation Board
- 30 Hackathon
- 3 PHP Bridge
- 6 Gacela Project
- 25 Job Opportunities
- 3.2K 📜 Slack Archives
- 116 Academy
- 5 Business Users
- 370 Docker
- 551 Slack General
- 2K Help
- 75 Knowledge Sharing
- 6 Random Stuff
- 4 Code Testing
- 32 Product & Business Questions
- 69 Spryker Safari Questions
- 50 Random