Skip to content

Commit e3d7642

Browse files
committed
Add validation notes for Unraid 7.2.3 across multiple documentation files
1 parent f54e07f commit e3d7642

8 files changed

Lines changed: 24 additions & 0 deletions

File tree

docs/core/notifications-system.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ nav_order: 6
77

88
# Notifications System
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Notify script location and options verified.
12+
1013
## Overview
1114

1215
Unraid has a built-in notification system that plugins can use to alert users. Notifications can appear in the web UI and optionally be sent via email, Pushover, Discord, Telegram, Slack, and other notification agents.

docs/core/rc-d-scripts.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ nav_order: 8
77

88
# rc.d Scripts
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Script location `/etc/rc.d/` and structure verified.
12+
1013
{: .warning }
1114
> This page is a stub. [Help us expand it!](https://github.com/mstrhakr/unraid-plugin-docs/blob/main/CONTRIBUTING.md)
1215

docs/events.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ mermaid: true
77

88
# Event System
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Event names and execution order verified against `/usr/local/sbin/emhttp_event`.
12+
1013
Unraid plugins can respond to system events by placing executable scripts in their `event/` directory. This allows plugins to perform actions when the array starts, Docker launches, or the system is shutting down.
1114

1215
## How Events Work

docs/filesystem.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ mermaid: true
77

88
# File System Layout
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Directory structures and paths verified on live systems.
12+
1013
Understanding where files are stored and why is crucial for Unraid plugin development. Unraid runs from RAM, which creates unique challenges and opportunities.
1114

1215
## The RAM-Based Architecture

docs/page-files.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ mermaid: true
77

88
# Page Files Reference
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Page file structure and header attributes verified against system plugins.
12+
1013
Page files (`.page`) are how plugins add pages to the Unraid web UI. They combine metadata headers with PHP/HTML/JavaScript content to create settings pages, tools, and dashboards.
1114

1215
## Basic Structure

docs/plg-file.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ nav_order: 3
66

77
# PLG File Reference
88

9+
{: .note }
10+
> **Validated against Unraid 7.2.3** - PLG structure and attributes verified against installed plugins.
11+
912
The `.plg` file is the heart of every Unraid plugin. It's an XML document that tells the plugin system how to install, update, and remove your plugin.
1013

1114
## Basic Structure

docs/reference/file-path-reference.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ nav_order: 2
77

88
# File Path Reference
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - Directory paths and persistence behavior verified.
12+
1013
{: .warning }
1114
> This page is a stub. [Help us expand it!](https://github.com/mstrhakr/unraid-plugin-docs/blob/main/CONTRIBUTING.md)
1215

docs/reference/var-array-reference.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ nav_order: 4
77

88
# $var Array Reference
99

10+
{: .note }
11+
> **Validated against Unraid 7.2.3** - All properties verified against `/var/local/emhttp/var.ini` on live systems.
12+
1013
## Overview
1114

1215
The `$var` array contains system state and configuration variables. It's one of the most important globals for plugin development, providing access to array status, disk information, system identity, and security tokens.

0 commit comments

Comments
 (0)