[PR #150] [MERGED] docs: update documentation, screenshots and mkdocs config #144

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

📋 Pull Request Information

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

Base: mainHead: docs/update-documentation-and-screenshots


📝 Commits (1)

  • 0c73a09 docs: update documentation, screenshots and mkdocs config

📊 Changes

33 files changed (+28 additions, -73 deletions)

View changed files

📝 docs/user/docs/editions.md (+1 -1)
docs/user/docs/icon.png (+0 -0)
📝 docs/user/docs/images/login.png (+0 -0)
📝 docs/user/docs/images/logo.png (+0 -0)
docs/user/docs/images/screenshot-autosnap.png (+0 -0)
docs/user/docs/images/screenshot-autosnap2.png (+0 -0)
docs/user/docs/images/screenshot-autosnap3.png (+0 -0)
📝 docs/user/docs/images/screenshot-backup-analytics.png (+0 -0)
docs/user/docs/images/screenshot-backup-analytics2.png (+0 -0)
📝 docs/user/docs/images/screenshot-dashboard.png (+0 -0)
docs/user/docs/images/screenshot-dashboard2.png (+0 -0)
docs/user/docs/images/screenshot-diagnostics.png (+0 -0)
docs/user/docs/images/screenshot-diagnostics2.png (+0 -0)
docs/user/docs/images/screenshot-portal.png (+0 -0)
docs/user/docs/images/screenshot-portal2.png (+0 -0)
docs/user/docs/images/screenshot-portal3.png (+0 -0)
docs/user/docs/images/screenshot-replication-analytics.png (+0 -0)
docs/user/docs/images/screenshot-replication-analytics2.png (+0 -0)
docs/user/docs/images/screenshot-reports.png (+0 -20)
📝 docs/user/docs/images/screenshot-resources-cluster.png (+0 -0)

...and 13 more files

📄 Description

Summary

  • Fix mkdocs.yml: correct edit_uri path (removed /new/), fix GitHub social icon (was incorrectly set to gitlab)
  • Update index.md: use images/logo.png, improve Enterprise Edition description with complete module list, refresh screenshots
  • Update editions.md: add AutoSnap EE enhancements column (Web API Hook)
  • Update autosnap.md: improve card descriptions (remove duplication between Retention/Storage), add Web API Hook card with <span class="ee"></span> badge
  • Remove outdated/unused screenshot images

Test plan

  • MkDocs builds without errors
  • Documentation site renders correctly
  • EE badge displays correctly on autosnap page
  • GitHub social icon shows correctly in footer

🔄 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/150 **Author:** [@franklupo](https://github.com/franklupo) **Created:** 2/16/2026 **Status:** ✅ Merged **Merged:** 2/16/2026 **Merged by:** [@franklupo](https://github.com/franklupo) **Base:** `main` ← **Head:** `docs/update-documentation-and-screenshots` --- ### 📝 Commits (1) - [`0c73a09`](https://github.com/Corsinvest/cv4pve-admin/commit/0c73a09254f1655b7fa11dfe28bbda8116689bef) docs: update documentation, screenshots and mkdocs config ### 📊 Changes **33 files changed** (+28 additions, -73 deletions) <details> <summary>View changed files</summary> 📝 `docs/user/docs/editions.md` (+1 -1) ➖ `docs/user/docs/icon.png` (+0 -0) 📝 `docs/user/docs/images/login.png` (+0 -0) 📝 `docs/user/docs/images/logo.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-autosnap.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-autosnap2.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-autosnap3.png` (+0 -0) 📝 `docs/user/docs/images/screenshot-backup-analytics.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-backup-analytics2.png` (+0 -0) 📝 `docs/user/docs/images/screenshot-dashboard.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-dashboard2.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-diagnostics.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-diagnostics2.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-portal.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-portal2.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-portal3.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-replication-analytics.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-replication-analytics2.png` (+0 -0) ➖ `docs/user/docs/images/screenshot-reports.png` (+0 -20) 📝 `docs/user/docs/images/screenshot-resources-cluster.png` (+0 -0) _...and 13 more files_ </details> ### 📄 Description ## Summary - Fix `mkdocs.yml`: correct `edit_uri` path (removed `/new/`), fix GitHub social icon (was incorrectly set to `gitlab`) - Update `index.md`: use `images/logo.png`, improve Enterprise Edition description with complete module list, refresh screenshots - Update `editions.md`: add AutoSnap EE enhancements column (Web API Hook) - Update `autosnap.md`: improve card descriptions (remove duplication between Retention/Storage), add Web API Hook card with `<span class="ee"></span>` badge - Remove outdated/unused screenshot images ## Test plan - [ ] MkDocs builds without errors - [ ] Documentation site renders correctly - [ ] EE badge displays correctly on autosnap page - [ ] GitHub social icon shows correctly in footer --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
kerem 2026-02-26 17:37:30 +03:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cv4pve-admin#144
No description provided.