Skip to content

Commit 93dc493

Browse files
author
rb
committed
docs: align readme and docs with 0.5.0 (drop tailwind, add folder board)
1 parent 139ee4d commit 93dc493

4 files changed

Lines changed: 7 additions & 4 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ NagVis, designed primarily for use **inside Checkmk**. Real-time live
55
updates over Server-Sent Events, native Checkmk integration with
66
main-menu entry and sidebar snapin, force-directed topology and geo
77
boards. Built with **FastAPI** · **Vue 3** · **TypeScript** · **Vite** ·
8-
**Pinia** · **Tailwind CSS** · **D3.js**.
8+
**Pinia** · **D3.js**, on the Checkmk design system.
99

1010
> **Status:** early release. OrbVis is primarily designed as a Checkmk
1111
> integration and runs wherever Checkmk itself is supported. The
@@ -93,7 +93,7 @@ Frontend on `http://localhost:8741`, API docs on `http://localhost:8742/api/docs
9393
```
9494
orbvis/
9595
├── backend/ Python 3.12 + FastAPI (async), stdlib sqlite3
96-
├── frontend/ Vue 3 + TypeScript + Vite + Tailwind CSS
96+
├── frontend/ Vue 3 + TypeScript + Vite (Checkmk design system)
9797
├── cmk_plugins/ Checkmk 2.4+ GUI plugins (sidebar, WATO permissions, menu)
9898
├── cmk_plugins_23/ Checkmk 2.3 GUI plugins
9999
├── scripts/ orbvis-setup / orbvis-install wrapper commands (in packages)

docs/architecture.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ the source of truth.
88
```
99
┌──────────────────────────────────────────────────────────────────┐
1010
│ Browser ──────────────────────────────────────────────────────│
11-
│ Vue 3 SPA · TypeScript · Pinia · Vite · Tailwind · D3 v7 │
11+
│ Vue 3 SPA · TypeScript · Pinia · Vite · D3 v7
1212
└────────────┬──────────────────────────────────────┬──────────────┘
1313
│ REST + JWT (access + refresh) │ Server-Sent Events
1414
│ /api/v1/… │ /api/v1/sse/boards/{name}
@@ -46,6 +46,8 @@ Board types:
4646
- **Flow** — D3 force-directed topology
4747
- **Radar** — severity grid
4848
- **Geo** — Leaflet world map with lat/lng objects and polylines
49+
- **Folder** — Checkmk SETUP folder tree as a treemap with worst-state
50+
bubbling; scales to six-digit host counts via SSE delta updates
4951

5052
Object types are unified across board types (host, service, hostgroup,
5153
servicegroup, board link, line, textbox, image, graph, BI). The same

docs/comparison.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ Legend: ✅ done · 🟡 partial / different · ❌ not yet · ➕ new in OrbVis
4949
| Geo map (lat / lng) with Leaflet | 🟡 [^2] ||
5050
| Force-directed topology (Flow board) |||
5151
| Severity grid (Radar board) |||
52+
| Folder tree as treemap (Folder board) |||
5253
| Multi-select + bulk move |||
5354
| Drag-drop reorder of boards on home screen |||
5455
| Inline edit panel (vs. modal-only edit) |||

docs/migration-from-nagvis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ The `line_type` integer decomposes into three orthogonal OrbVis attributes:
4747
- **Backend connection definitions** — NagVis' `[backend_*]` sections are
4848
not converted. Configure backends in OrbVis via *Admin → Backends*
4949
(or `backends.json`).
50-
- **Custom CSS / templates** — OrbVis uses Vue + Tailwind, not PHP
50+
- **Custom CSS / templates** — OrbVis uses Vue components, not PHP
5151
templates. Visual customisation goes through board settings and the
5252
hover/context menu template fields.
5353

0 commit comments

Comments
 (0)