Skip to content

Commit 6f2160a

Browse files
committed
Visible SVG screenshot placeholders
Replace the invisible 1x1 PNG placeholders with per-slot SVG placeholders that render as dashed-border boxes with the slot title, description, and a "replace with <slot>.png" hint. Reviewers and the user can now see exactly where each screenshot belongs on the rendered page. Updated TODO comments to spell out the swap path (.svg -> .png) and added images/README.md with the replacement workflow.
1 parent 9b46007 commit 6f2160a

35 files changed

Lines changed: 394 additions & 40 deletions

docs/vscode-extension/configuration.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ description: Configure the B2C DX VS Code Extension — feature toggles, log lev
66

77
The extension reads B2C Commerce credentials from the same sources as the [B2C CLI](../guide/configuration) (`dw.json`, `SFCC_*` environment variables, `~/.dw.json`, etc.). This page covers the **VS Code-specific** settings under the `b2c-dx.*` namespace, configurable via **Settings** (Cmd+,) → search for `b2c-dx`, or directly in `settings.json`.
88

9-
<!-- TODO(screenshot): settings.png — Settings UI filtered to b2c-dx -->
10-
![B2C DX settings](./images/settings.png)
9+
<!-- TODO(screenshot): replace ./images/settings.svg with ./images/settings.png — Settings UI filtered to b2c-dx -->
10+
![B2C DX settings](./images/settings.svg)
1111

1212
## Feature Toggles
1313

@@ -43,8 +43,8 @@ The B2C Script Debugger registers regardless of these toggles — it activates o
4343

4444
Allowed values: `trace`, `debug`, `info`, `warn`, `error`, `silent`. The setting is applied immediately on change — no reload needed.
4545

46-
<!-- TODO(screenshot): output-channel.png — B2C DX output channel showing log stream -->
47-
![B2C DX output channel](./images/output-channel.png)
46+
<!-- TODO(screenshot): replace ./images/output-channel.svg with ./images/output-channel.png — B2C DX output channel showing log stream -->
47+
![B2C DX output channel](./images/output-channel.svg)
4848

4949
The output channel surfaces SDK logs (request/response summaries, safety-mode evaluations, polling events) plus extension lifecycle events. Drop to `debug` or `trace` when filing a bug report.
5050

docs/vscode-extension/features.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ Browse and manage on-demand sandboxes (ODS) for one or more realms in a dedicate
1414

1515
**Cloned sandbox indicators** — clones are tagged in the tree. While a clone is being set up, the source sandbox is shown as `cloning` and the new (target) sandbox is shown as `setting up`. Once the clone stabilizes, both rows display their actual states (`started`, `stopped`, etc.) and the cloned target keeps a visual marker so you can tell it apart from a freshly created sandbox.
1616

17-
<!-- TODO(screenshot): sandbox-explorer.png — started + cloned sandbox in the tree -->
18-
![Sandbox Realm Explorer](./images/sandbox-explorer.png)
17+
<!-- TODO(screenshot): replace ./images/sandbox-explorer.svg with ./images/sandbox-explorer.png — started + cloned sandbox in the tree -->
18+
![Sandbox Realm Explorer](./images/sandbox-explorer.svg)
1919

20-
<!-- TODO(screenshot): sandbox-context-menu.png — right-click context menu over a started sandbox -->
21-
![Sandbox context menu](./images/sandbox-context-menu.png)
20+
<!-- TODO(screenshot): replace ./images/sandbox-context-menu.svg with ./images/sandbox-context-menu.png — right-click context menu over a started sandbox -->
21+
![Sandbox context menu](./images/sandbox-context-menu.svg)
2222

2323
Polling cadence is controlled by [`b2c-dx.sandbox.pollingInterval`](./configuration#sandbox-polling-interval).
2424

@@ -33,11 +33,11 @@ A tree of WebDAV catalogs and libraries plus a registered file-system provider (
3333
- **Drag & drop** — drag files from your local Explorer into a WebDAV directory to upload.
3434
- **Add Catalog / Add Library** — register additional virtual roots for browsing.
3535

36-
<!-- TODO(screenshot): webdav-browser.png — catalogs and libraries expanded -->
37-
![WebDAV Browser](./images/webdav-browser.png)
36+
<!-- TODO(screenshot): replace ./images/webdav-browser.svg with ./images/webdav-browser.png — catalogs and libraries expanded -->
37+
![WebDAV Browser](./images/webdav-browser.svg)
3838

39-
<!-- TODO(screenshot): webdav-mounted.png — "Open as Workspace Folder" result -->
40-
![WebDAV mounted as workspace folder](./images/webdav-mounted.png)
39+
<!-- TODO(screenshot): replace ./images/webdav-mounted.svg with ./images/webdav-mounted.png — "Open as Workspace Folder" result -->
40+
![WebDAV mounted as workspace folder](./images/webdav-mounted.svg)
4141

4242
## Content Libraries
4343

@@ -50,8 +50,8 @@ A focused view for Page Designer pages and components stored in your content lib
5050
- **Browse in WebDAV** — jump from a library entry to the corresponding WebDAV path.
5151
- **Import Site Archive** — right-click a folder in the Explorer to import it as a site archive.
5252

53-
<!-- TODO(screenshot): content-libraries.png — content tree with the export context menu -->
54-
![Content Libraries](./images/content-libraries.png)
53+
<!-- TODO(screenshot): replace ./images/content-libraries.svg with ./images/content-libraries.png — content tree with the export context menu -->
54+
![Content Libraries](./images/content-libraries.svg)
5555

5656
## Cartridge Code Sync
5757

@@ -63,17 +63,17 @@ A **Cartridges** tree view (under the **B2C-DX** activity-bar container) lists e
6363

6464
**Workspace toggles**: **Toggle Code Sync** / **Start Code Sync** / **Stop Code Sync** start a watcher that uploads on save. **Upload to Instance** is also available from the file Explorer's context menu when a code-sync session is active.
6565

66-
<!-- TODO(screenshot): code-sync.png — Cartridges view with code-version dropdown -->
67-
![Cartridge Code Sync](./images/code-sync.png)
66+
<!-- TODO(screenshot): replace ./images/code-sync.svg with ./images/code-sync.png — Cartridges view with code-version dropdown -->
67+
![Cartridge Code Sync](./images/code-sync.svg)
6868

6969
## SCAPI API Browser
7070

7171
Browse SCAPI OpenAPI schemas for your instance and open a Swagger UI panel for any endpoint. Requires OAuth credentials (`clientId`, `clientSecret`) and `shortCode` in `dw.json` — see the [Authentication Setup guide](../guide/authentication).
7272

7373
The view lives in its own activity-bar container (**B2C-DX: SCAPI**). Use **Refresh** to reload schemas after changing instances, and **Open API Documentation** to launch the Swagger UI panel.
7474

75-
<!-- TODO(screenshot): api-browser.png — Swagger UI panel -->
76-
![SCAPI API Browser](./images/api-browser.png)
75+
<!-- TODO(screenshot): replace ./images/api-browser.svg with ./images/api-browser.png — Swagger UI panel -->
76+
![SCAPI API Browser](./images/api-browser.svg)
7777

7878
## B2C Script Debugger
7979

@@ -94,24 +94,24 @@ Registered as debug type `b2c-script`. Add a launch configuration to `.vscode/la
9494

9595
`cartridgePath` is auto-detected from the workspace; override it explicitly only if the cartridges live outside the workspace root.
9696

97-
<!-- TODO(screenshot): script-debugger.png — paused on a breakpoint -->
98-
![B2C Script Debugger](./images/script-debugger.png)
97+
<!-- TODO(screenshot): replace ./images/script-debugger.svg with ./images/script-debugger.png — paused on a breakpoint -->
98+
![B2C Script Debugger](./images/script-debugger.svg)
9999

100100
## Scaffold & CAP install
101101

102102
**Scaffold** (`b2c-dx.scaffold.generate`) — quick-pick over the SDK's scaffold templates; appears in the **File → New File...** picker and as **New from Scaffold...** when you right-click a folder in the Explorer.
103103

104104
**CAP install** (`b2c-dx.cap.install`) — appears on the right-click menu of a folder in the Explorer when the folder contains a `commerce-app.json`. Activation is also wired to `workspaceContains:**/commerce-app.json` so the extension auto-activates when you open a CAP project.
105105

106-
<!-- TODO(screenshot): scaffold-picker.png — "New from Scaffold..." quick-pick -->
107-
![Scaffold quick-pick](./images/scaffold-picker.png)
106+
<!-- TODO(screenshot): replace ./images/scaffold-picker.svg with ./images/scaffold-picker.png — "New from Scaffold..." quick-pick -->
107+
![Scaffold quick-pick](./images/scaffold-picker.svg)
108108

109109
## Page Designer Assistant
110110

111111
`b2c-dx.openUI` opens a guided webview UI for scaffolding a Storefront Next page (PageType + Region definitions). The generated `.tsx` file is written to your workspace's `routes/` folder when one exists, or to a path you pick when the workspace has no routes folder.
112112

113-
<!-- TODO(screenshot): page-designer-assistant.png -->
114-
![Page Designer Assistant](./images/page-designer-assistant.png)
113+
<!-- TODO(screenshot): replace ./images/page-designer-assistant.svg with ./images/page-designer-assistant.png -->
114+
![Page Designer Assistant](./images/page-designer-assistant.svg)
115115

116116
## Log Tailing
117117

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Screenshot placeholders
2+
3+
Each `<slot>.svg` in this directory is a visible "Screenshot placeholder" used by the VS Code extension docs pages. They render as dashed-border boxes with the slot title and a description, so reviewers can see exactly where a real screenshot belongs.
4+
5+
## Replacing a placeholder
6+
7+
1. Capture the screenshot as a PNG at retina resolution (typically ~2560×1440 max).
8+
2. Save it as `./<slot>.png` in this directory (use the same `<slot>` name as the SVG).
9+
3. In the markdown page that references it, swap the `.svg` extension for `.png`:
10+
11+
```diff
12+
- ![Sandbox Realm Explorer](./images/sandbox-explorer.svg)
13+
+ ![Sandbox Realm Explorer](./images/sandbox-explorer.png)
14+
```
15+
16+
4. Remove the corresponding `<!-- TODO(screenshot): … -->` comment.
17+
5. (Optional) Delete the `.svg` placeholder once all slots referencing it are replaced.
18+
19+
To enumerate every remaining placeholder, grep the docs:
20+
21+
```bash
22+
grep -rn "TODO(screenshot)" docs/vscode-extension/
23+
```
24+
25+
## Slot inventory
26+
27+
| Slot | Used on |
28+
| ---- | ------- |
29+
| `overview` | `index.md` |
30+
| `sandbox-explorer`, `sandbox-context-menu` | `features.md`, `index.md` |
31+
| `webdav-browser`, `webdav-mounted` | `features.md`, `index.md` |
32+
| `content-libraries` | `features.md` |
33+
| `code-sync` | `features.md`, `index.md` |
34+
| `api-browser` | `features.md` |
35+
| `script-debugger` | `features.md`, `index.md` |
36+
| `page-designer-assistant` | `features.md`, `index.md` |
37+
| `scaffold-picker` | `features.md` |
38+
| `release-assets`, `install-vsix` | `installation.md` |
39+
| `settings`, `output-channel` | `configuration.md` |
-69 Bytes
Binary file not shown.
Lines changed: 21 additions & 0 deletions
Loading
-69 Bytes
Binary file not shown.
Lines changed: 21 additions & 0 deletions
Loading
-69 Bytes
Binary file not shown.
Lines changed: 21 additions & 0 deletions
Loading
-69 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)