Skip to content

Commit a1b3b24

Browse files
authored
Merge pull request #162 from stellarwp/docs/frontend-updates
Update docs to reflect frontend changes
2 parents 8e0b96d + c8f5113 commit a1b3b24

2 files changed

Lines changed: 104 additions & 51 deletions

File tree

docs/architecture/conventions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ Prefix: `lw-harbor-`
121121
### CSS Scope and DOM
122122

123123
```html
124-
<div id="lw-harbor-root" class="lw-harbor"></div>
124+
<div id="lw-harbor-root" class="lw-harbor-ui"></div>
125125
```
126126

127-
The `.lw-harbor` class is the Tailwind CSS scope boundary. A PostCSS plugin (`scopeToLwHarbor`) prefixes all generated selectors with `.lw-harbor` to prevent style conflicts with the WordPress admin.
127+
The `.lw-harbor-ui` class is the Tailwind CSS scope boundary. A PostCSS plugin (`scopeToHarborUI`) prefixes all generated selectors with `.lw-harbor-ui` to prevent style conflicts with the WordPress admin. The `lw-harbor` prefix family remains the canonical namespace for IDs and other DOM identifiers.
128128

129129
### Script Handles
130130

@@ -142,11 +142,11 @@ wp_enqueue_script( 'lw-harbor-notice-dismiss', ... );
142142

143143
| Identifier | Convention |
144144
| ------------------ | --------------------------------------- |
145-
| Error class | `LiquidError` (file: `liquid-error.ts`) |
146-
| Store name | `'lw'` |
145+
| Error class | `HarborError` (file: `harbor-error.ts`) |
146+
| Store name | `'lw/harbor'` |
147147
| Store registration | `registerHarborStore` |
148148
| Store import alias | `harborStore` |
149-
| REST paths | `'/liquidweb/harbor/v1/...'` |
149+
| REST paths | `'/liquidweb/harbor/v1/...'` |
150150
| Docblock package | `@package LiquidWeb\Harbor` |
151151

152152
<!-- markdownlint-enable MD060 -->
@@ -178,7 +178,7 @@ The library version starts at `0.0.1`. All `@since` tags for new code use `@sinc
178178
| Global functions | `lw_harbor` | `_` | `lw_harbor_is_feature_enabled()` |
179179
| WP-CLI | `harbor` | ` ` | `wp harbor feature list` |
180180
| Error codes (PHP) | `lw-harbor` | `-` | `lw-harbor-feature-not-found` |
181-
| CSS/DOM | `lw-harbor` | `-` | `.lw-harbor`, `#lw-harbor-root` |
181+
| CSS/DOM | `lw-harbor` | `-` | `.lw-harbor-ui`, `#lw-harbor-root` |
182182
| Script handles | `lw-harbor` | `-` | `lw-harbor-ui` |
183183

184184
<!-- markdownlint-enable MD060 -->

0 commit comments

Comments
 (0)