Skip to content

Commit 832683c

Browse files
committed
docs(coding-agent): add standardized Device Info visual template and guidance
- add for section-by-section Postman visualizer scaffolding - codify block layout and display label standards (, , , ) - link to the visual template as the default starting point for new visuals - 2026-02-22 20:46:17
2 parents fab5518 + cbc865e commit 832683c

4 files changed

Lines changed: 777 additions & 2 deletions

File tree

CODING_AGENTS.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,21 @@
3131
## Visual Development Rules (Required)
3232

3333
- `visual/` is the source of truth for visual HTML (`*.html`) and sample JSON (`*.json`) in this repo version.
34+
- Start new visual work from `visual/templates/Postman-Visualizer-SectionTemplate.md` and build the page section-by-section from that scaffold.
3435
- Do not manually edit generated visual docs (`docs/visual/`, `docs/visual-previews/`); regenerate from `visual/`.
3536
- No comments in visual code/templates unless explicitly requested.
3637
- At the top of each visual HTML file, maintain the visual rules/constraints and indicate that `CODING_AGENTS.md` defines the canonical rules so they are not forgotten.
3738
- Visuals should support dark/light mode behavior and check system settings when rendering theme-sensitive output.
3839
- If `sysDescr` / `system_description` is present in the JSON response, show it prominently at the top of the visual.
40+
- Standardize `sysDescr` / `system_description` presentation as a dedicated `Device Info` block separate from channel/capture graph blocks.
41+
- `Device Info` should render before channel-specific charts/content.
42+
- Prefer a horizontal one-row table for common modem identity fields with display labels exactly:
43+
- `MacAddress`, `Model`, `Vendor`, `SW Version`, `HW Version`, `Boot ROM`
44+
- Use proper display casing/spacing for labels (for example `SW Version`, not `SW_REV`; `Boot ROM`, not `BOOTR`).
45+
- Keep channel metadata in a separate block below `Device Info` (for example `Channel`, center/subcarrier frequency).
46+
- Display frequencies in `MHz` for UI-facing labels; raw `Hz` may be shown secondarily in parentheses when useful.
47+
- Avoid redundant repetition of values already shown in `Device Info` (for example, do not repeat `MacAddress` in the channel header if it is already in the device table).
48+
- If `system_description` is missing/partial, render `N/A` for missing fields instead of vendor-specific fallback values.
3949
- JSON responses may contain multiple upstream/downstream channels; each channel must render as its own graph for the selected graph type.
4050
- Multi-channel views should also include a combined graph at the bottom with all channels lined up by frequency in a single graph.
4151

0 commit comments

Comments
 (0)