mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-07-30 11:43:26 +08:00
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:
parent
4a1cf7a6e6
commit
30052ef628
@ -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):
|
**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.
|
- [ ] **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 [handle-ui-components.md](docs/handle-ui-components.md) if creating a new theme layout component.
|
|
||||||
- [ ] MUST read [configure-content-themeLayout.md](docs/configure-content-themeLayout.md).
|
- [ ] 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
|
- [ ] MUST read [configure-content-view.md](docs/configure-content-view.md) if need to apply theme layout to pages
|
||||||
|
|
||||||
|
|||||||
@ -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.
|
**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
|
### _meta.json Structure
|
||||||
|
|
||||||
The `_meta.json` file must contain:
|
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:
|
When generating a new theme layout, ensure:
|
||||||
|
|
||||||
- [ ] `_meta.json` created with correct `apiName`, `type`, and `path` (III)
|
- [ ] `_meta.json` created with correct `apiName`, `type`, and `path`
|
||||||
- [ ] `content.json` created with all required fields (IV)
|
- [ ] `content.json` created with all required fields
|
||||||
- [ ] `urlName` uses lowercase with hyphens (V)
|
- [ ] `urlName` uses lowercase with hyphens
|
||||||
- [ ] `title` is human-readable (V)
|
- [ ] `title` is human-readable
|
||||||
- [ ] `sfdc_cms__theme/[THEME_API_NAME]/content.json` updated by appending a new `contentBody.layouts` mapping (VI)
|
- [ ] `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)
|
- [ ] **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
|
## Purpose B: Editing Existing Theme Layouts
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user