[PR #154] [MERGED] docs: add Dashboard module documentation and update editions/modules index #146

New issue

Closed

opened 2026-02-26 17:37:30 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 17:37:30 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Corsinvest/cv4pve-admin/pull/154
Author: @franklupo
Created: 2/17/2026
Status: ✅ Merged
Merged: 2/17/2026
Merged by: @franklupo

Base: main ← Head: docs/dashboard-and-editions

📝 Commits (2)

eda3cb1 refactor: remove redundant ModuleType from Widget and simplify GetModuleWidget
dec3a99 docs: add Dashboard module documentation and update editions/modules index

📊 Changes

9 files changed (+271 additions, -60 deletions)

View changed files

📝 docs/user/docs/editions.md (+13 -13)
📝 docs/user/docs/modules/dashboard.md (+92 -2)
📝 docs/user/docs/modules/index.md (+1 -0)
📝 src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Components/Dashboard.razor.cs (+0 -1)
➕ src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/20260217125654_RemoveWidgetModuleType.Designer.cs (+128 -0)
➕ src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/20260217125654_RemoveWidgetModuleType.cs (+32 -0)
📝 src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/ModuleDbContextModelSnapshot.cs (+2 -12)
📝 src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Models/Widget.cs (+3 -5)
📝 src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/dashboards.json (+0 -27)

📄 Description

Summary

Add complete dashboard.md documentation: feature overview (multiple dashboards, widget library, multi-cluster filter, auto-refresh, screen preview, import/export), edit mode operations, built-in widgets (Web Content, Memo), and table of widgets provided by other modules
Update modules/index.md: use official Categories from code (Categories.cs) — Protection, Health, Control, Utilities — and add Dashboard under Utilities
Update editions.md: add clickable links to module documentation pages for all modules that have a dedicated page; fix Dashboard category from Application to Utilities

Test plan

Verify dashboard.md renders correctly in MkDocs
Verify all links in editions.md resolve correctly
Verify modules/index.md categories match the app sidebar

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Corsinvest/cv4pve-admin/pull/154 **Author:** [@franklupo](https://github.com/franklupo) **Created:** 2/17/2026 **Status:** ✅ Merged **Merged:** 2/17/2026 **Merged by:** [@franklupo](https://github.com/franklupo) **Base:** `main` ← **Head:** `docs/dashboard-and-editions` --- ### 📝 Commits (2) - [`eda3cb1`](https://github.com/Corsinvest/cv4pve-admin/commit/eda3cb1acd4270fb4579f907c1b7a5a90585be7d) refactor: remove redundant ModuleType from Widget and simplify GetModuleWidget - [`dec3a99`](https://github.com/Corsinvest/cv4pve-admin/commit/dec3a99c7a8db06d2b1704ba3ea637bbba68c6fd) docs: add Dashboard module documentation and update editions/modules index ### 📊 Changes **9 files changed** (+271 additions, -60 deletions) <details> <summary>View changed files</summary> 📝 `docs/user/docs/editions.md` (+13 -13) 📝 `docs/user/docs/modules/dashboard.md` (+92 -2) 📝 `docs/user/docs/modules/index.md` (+1 -0) 📝 `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Components/Dashboard.razor.cs` (+0 -1) ➕ `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/20260217125654_RemoveWidgetModuleType.Designer.cs` (+128 -0) ➕ `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/20260217125654_RemoveWidgetModuleType.cs` (+32 -0) 📝 `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Migrations/ModuleDbContextModelSnapshot.cs` (+2 -12) 📝 `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/Models/Widget.cs` (+3 -5) 📝 `src/Corsinvest.ProxmoxVE.Admin.Module.Dashboard/dashboards.json` (+0 -27) </details> ### 📄 Description ## Summary - Add complete `dashboard.md` documentation: feature overview (multiple dashboards, widget library, multi-cluster filter, auto-refresh, screen preview, import/export), edit mode operations, built-in widgets (Web Content, Memo), and table of widgets provided by other modules - Update `modules/index.md`: use official Categories from code (`Categories.cs`) — Protection, Health, Control, Utilities — and add Dashboard under Utilities - Update `editions.md`: add clickable links to module documentation pages for all modules that have a dedicated page; fix Dashboard category from Application to Utilities ## Test plan - [ ] Verify dashboard.md renders correctly in MkDocs - [ ] Verify all links in editions.md resolve correctly - [ ] Verify modules/index.md categories match the app sidebar --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>