feat: update theme layout creation instructions (#122)

* feat: update theme layout creation instructions

* fix: revert UI component section

* feat: specify order of operations for theme layout creation

---------

Co-authored-by: Hemant Singh Bisht <hsinghbisht@salesforce.com>
This commit is contained in:
Jeff Carey 2026-03-31 12:48:03 -04:00 committed by GitHub
parent 4a1cf7a6e6
commit 30052ef628
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 7 deletions

View File

@ -145,8 +145,7 @@ Before doing anything, you **MUST ALWAYS** load them first if they match user in
**Steps** (Follow the steps sequentially. Do not skip any step before proceeding):
- [ ] Check with user whether this new theme layout reuses an existing theme layout component or requires a new one.
- [ ] MUST read [handle-ui-components.md](docs/handle-ui-components.md) if creating a new theme layout component.
- [ ] **CRITICAL**:Before doing anything else, MUST Check with user whether this new theme layout reuses an existing theme layout Lightning web component or requires a new one. If it requires a new one, make sure to read [handle-ui-components.md](docs/handle-ui-components.md) to create the new theme layout component before proceeding. DO NOT skip this step even if doing so would be faster or more efficient.
- [ ] MUST read [configure-content-themeLayout.md](docs/configure-content-themeLayout.md).
- [ ] MUST read [configure-content-view.md](docs/configure-content-view.md) if need to apply theme layout to pages

View File

@ -26,6 +26,9 @@
**IMPORTANT**: These guidelines should ONLY be applied when the user explicitly requests creating a new layout for their site. Do not apply these guidelines automatically for other tasks or when editing existing layouts.
### Order of operations
If the user decides to create a new LWC, create the LWC first THEN the theme layout metadata.
### _meta.json Structure
The `_meta.json` file must contain:
@ -126,11 +129,11 @@ digitalExperiences/site/[SITE_NAME]/sfdc_cms__theme/[THEME_API_NAME]/content.jso
When generating a new theme layout, ensure:
- [ ] `_meta.json` created with correct `apiName`, `type`, and `path` (III)
- [ ] `content.json` created with all required fields (IV)
- [ ] `urlName` uses lowercase with hyphens (V)
- [ ] `title` is human-readable (V)
- [ ] `sfdc_cms__theme/[THEME_API_NAME]/content.json` updated by appending a new `contentBody.layouts` mapping (VI)
- [ ] `_meta.json` created with correct `apiName`, `type`, and `path`
- [ ] `content.json` created with all required fields
- [ ] `urlName` uses lowercase with hyphens
- [ ] `title` is human-readable
- [ ] `sfdc_cms__theme/[THEME_API_NAME]/content.json` updated by appending a new `contentBody.layouts` mapping
- [ ] **CRITICAL**: Complete all the UUID generation steps. See [handle-component-and-region-ids.md](docs/handle-component-and-region-ids.md)
## Purpose B: Editing Existing Theme Layouts