Repository navigation
docs: consolidate the CMS guides - #2793
Merged
Merged
Conversation
Merge two CMS guides into the pages that cover the same task, then redirect them: - guides/cms/customize-components -> overwriting-cms - guides/cms/custom-elements -> missing-component, carrying over the backend name to component name mapping, typing config from the registered defaultConfig, global registration in a plain Vue app and the link to the backend guide Rewrite overwriting-cms around the rule the base layer README states: an override must sit under a path registered with global: true (app/components/cms/ in vue-starter-template), while Sw* components are auto-imported and go into app/components/. Drop its "Resolving folder structure" section, which described Nuxt's pathPrefix naming that the starter and the layer both switch off. Fix missing-component: create the file under app/components/cms/, a missing section renders a "There is no ..." line in every mode rather than the placeholder, read element settings through getConfigValue, and log the console warning the placeholder comes with. Trim create-blocks (the setup-time getSlotContent example the rendering recipe warns against), fix the create-elements paths, highlighted lines and the containerStyle comment, and cut the component mapping and the missing component walkthrough from concepts/shopping-experiences in favour of the rendering recipe and missing-component. Link the CMS recipes from the guides and the CMS index.
Contributor
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
The missing-section path currently presents block or element implementation code instead of a section-specific example.
Review effort: Balanced
Findings: 1
Open (1)
What changed in this PR
Consolidates CMS documentation around missing and overridden components, replacing legacy guides with redirects and aligning examples with the Vue Starter Template.
Changes:
- Consolidates legacy CMS guides and updates navigation and redirects.
- Expands missing-component guidance and typed examples.
- Standardizes CMS component paths under
app/components/cms/.
| File | Description |
|---|---|
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-4-verify.ts |
Adds global registration example. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-3-render-the-content.vue |
Updates block example path. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-3-render-the-content-2.vue |
Adds typed element configuration example. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-2-define-the-props.vue |
Updates component path. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-2-define-the-props-2.ts |
Adds Administration registration example. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/step-1-create-the-file |
Documents the CMS directory structure. |
examples/docs-code-examples/src/generated/guides/cms/missing-component/components/cms/CmsElementDailymotion.vue |
Adds an importable example component. |
examples/docs-code-examples/src/generated/guides/cms/customize-components/create-new-files.txt |
Removes obsolete snippet. |
examples/docs-code-examples/src/generated/guides/cms/custom-elements/vue-apps.ts |
Removes migrated registration snippet. |
examples/docs-code-examples/src/generated/guides/cms/custom-elements/reading-config-2.ts |
Removes migrated config snippet. |
examples/docs-code-examples/src/generated/guides/cms/custom-elements/naming.vue |
Removes legacy component example. |
examples/docs-code-examples/src/generated/guides/cms/custom-elements/naming.ts |
Removes legacy naming example. |
examples/docs-code-examples/src/generated/guides/cms/custom-elements/naming.js |
Removes legacy resolver example. |
examples/docs-code-examples/src/generated/guides/cms/create-elements/example.vue |
Updates element path. |
examples/docs-code-examples/src/generated/guides/cms/create-elements/example-3.vue |
Updates path and annotations. |
examples/docs-code-examples/src/generated/guides/cms/create-elements/example-2.vue |
Updates element path. |
examples/docs-code-examples/src/generated/guides/cms/create-blocks/slots.vue |
Removes redundant block example. |
examples/docs-code-examples/src/generated/guides/cms/create-blocks/example.vue |
Updates block path. |
examples/docs-code-examples/src/generated/concepts/shopping-experiences/data-component-mapping |
Removes duplicated mapping diagram. |
apps/docs/src/guides/cms/overwriting-cms.md |
Rewrites component override guidance. |
apps/docs/src/guides/cms/missing-component.md |
Expands the missing-component workflow. |
apps/docs/src/guides/cms/index.md |
Updates CMS guide navigation. |
apps/docs/src/guides/cms/customize-components.md |
Redirects the legacy customization guide. |
apps/docs/src/guides/cms/custom-elements.md |
Redirects the legacy custom-elements guide. |
apps/docs/src/guides/cms/create-elements.md |
Refreshes element examples and references. |
apps/docs/src/guides/cms/create-blocks.md |
Simplifies block creation guidance. |
apps/docs/src/guides/cms/content-pages.md |
Updates the override-guide link. |
apps/docs/src/getting-started/cms/customize-components.md |
Redirects to the consolidated override guide. |
apps/docs/src/getting-started/cms/custom-elements.md |
Redirects to the missing-component guide. |
apps/docs/src/frontends-recipes/cms/contact-form.md |
Updates the related CMS guide link. |
apps/docs/src/concepts/shopping-experiences.md |
Condenses CMS rendering documentation. |
apps/docs/.vitepress/sidebar.ts |
Removes superseded sidebar entries. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Contributor
|
[Automation] PR looks good |
Patryk Tomczyk (patzick)
approved these changes
Sep 29, 2026
This branch was previously deployed
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.
closes #2798
This pull request restructures and clarifies the documentation around customizing and implementing CMS components, especially focusing on missing or custom CMS elements. The main changes include consolidating and redirecting older guides to a new, more comprehensive page on implementing missing CMS components, updating navigation and sidebar links, and improving code examples for clarity and consistency.
Documentation structure and navigation:
Content improvements and consolidation:
Code example consistency:
app/components/cms/) and improved code highlighting and clarity in the "Create Blocks" and "Create Elements" guides. [1] [2] [3] [4] [5] [6] [7] [8]These changes make the documentation easier to navigate, reduce duplication, and provide a clearer path for developers implementing or customizing CMS components.