feat: frontends-recipes POC - login page - #2468
Open
Maciej D (mdanilowicz) wants to merge 21 commits into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
2 Skipped Deployments
|
Developer Docs healthcheckStatus: Completed with |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR introduces the initial “Frontends Recipes” documentation section in apps/docs, including a first end-to-end “Login” recipe, plus supporting VitePress data loaders and UI components to visualize the flow and surface generated Store API schema/type information.
Changes:
- Added a new “Frontends Recipes” docs section with an Account area and a detailed Login recipe.
- Introduced interactive diagrams/components (
LoginFlowDiagram,LoginVueFlowDiagram) and aSchemaTypeTooltipthat displays summarized OpenAPI schema/type info. - Added VitePress loaders for OpenAPI schema summaries and composables metadata, and wired recipes into the docs sidebar.
Reviewed changes
Copilot reviewed 12 out of 16 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Updates lockfile for new docs tooling dependencies. |
| apps/docs/package.json | Adds docs devDependencies and scripts for updating schema JSON files. |
| apps/docs/src/frontends-recipes/index.md | Adds the top-level “Frontends Recipes” landing page. |
| apps/docs/src/frontends-recipes/account/index.md | Adds the “Account” recipes landing page and links to Login. |
| apps/docs/src/frontends-recipes/account/login.md | Adds the end-to-end Login recipe content and references diagrams/tooltips. |
| apps/docs/.vitepress/sidebar.ts | Registers the new recipes section in the sidebar and updates composables loader import. |
| apps/docs/.vitepress/theme/components/ComposablesList.vue | Updates composables loader import path. |
| apps/docs/src/components/LoginFlowDiagram.vue | Adds a step-based login flow diagram with schema type tooltips. |
| apps/docs/src/components/LoginVueFlowDiagram.vue | Adds a Vue Flow-based login diagram with schema type tooltips. |
| apps/docs/src/components/SchemaTypeTooltip.vue | Adds a reusable tooltip component backed by OpenAPI schema summaries. |
| apps/docs/src/.data/openapi-schema.data.ts | Adds a VitePress loader that provides schema summaries to the UI. |
| apps/docs/src/.data/composables.data.ts | Adds a VitePress loader that extracts composables metadata via ts-dox. |
| apps/docs/src/.data/schema/openapi-resolver.ts | Adds a resolver for loading and indexing the docs OpenAPI schemas. |
| apps/docs/src/.data/schema/schema-summary.ts | Adds logic to summarize operations/schemas into tooltip-friendly data. |
Files not reviewed (1)
- pnpm-lock.yaml: Generated file
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Björn Meyer (BrocksiNet)
approved these changes
Jul 20, 2026
vercel
Bot
temporarily deployed
to
Preview – frontends-vue-starter-template
July 21, 2026 09:03
Inactive
vercel
Bot
temporarily deployed
to
Preview – frontends-starter-template-extended
July 21, 2026 09:03
Inactive
vercel
Bot
temporarily deployed
to
Preview – frontends-starter-template-extended
July 21, 2026 12:09
Inactive
vercel
Bot
temporarily deployed
to
Preview – frontends-vue-starter-template
July 21, 2026 12:09
Inactive
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.
📚 Add Frontends Recipes Documentation
✨ What is this MR about?
This MR introduces the foundation for Frontends Recipes: practical, end-to-end documentation pages that show how to build common storefront features with Shopware Frontends.
The goal is to go beyond isolated API or composable references and provide developers with real implementation-oriented examples. Recipes should answer questions like:
Instead of documenting only individual building blocks, recipes explain how those building blocks work together in actual storefront flows.
🎯 Why do we need Frontends Recipes?
Shopware Frontends already provides powerful APIs, composables, helpers, CMS components, and Nuxt integration. However, developers often need guidance on how to combine them correctly in practical scenarios.
Recipes help bridge the gap between:
They provide a more guided learning path for developers who want to build storefront features without having to reverse-engineer patterns from the demo store or existing templates.
🚀 What value does this bring?
Frontends Recipes should help us:
This should be especially useful for developers who are new to Shopware Frontends, but also for experienced teams that want a quick reference for recommended implementation patterns.
🧑💻 Example recipe topics
Potential recipes could cover flows such as:
🧠 Documentation approach
The recipes should be written from a practical perspective:
The intention is not to duplicate the API reference, but to give developers a clear path from idea to implementation.
✅ Expected outcome
After this change, developers should have a clearer and more approachable way to learn how to build with Shopware Frontends.
Instead of asking “which API should I use?”, they can start from a recipe like “Build a product listing” or “Add products to cart” and follow a documented implementation path.
This should make the documentation more useful, more discoverable, and closer to how developers actually work when building storefronts.
🧪 Testing / verification
Frontends recipes would give developers practical, end-to-end examples for common storefront flows. Instead of only documenting individual composables or APIs, recipes would show how to combine them in real scenarios like product listings, cart, checkout, customer accounts, CMS, or caching.
This should make onboarding faster, reduce repeated questions, and help teams build with more consistent patterns.
closes #2467