Skip to content

Commit bdaf270

Browse files
authored
Merge branch 'main' into patch-1
2 parents e626465 + b3edf5f commit bdaf270

57 files changed

Lines changed: 288 additions & 147 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/copilot-instructions.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Copilot Instructions for unraid-plugin-docs
1+
# Copilot Instructions for plugin-docs
22

3-
This is a Jekyll documentation site for Unraid plugin development, hosted on GitHub Pages using the [just-the-docs](https://just-the-docs.github.io/just-the-docs/) theme.
3+
This is a Jekyll documentation site for Unraid® plugin development, hosted on GitHub Pages using the [just-the-docs](https://just-the-docs.github.io/just-the-docs/) theme.
4+
5+
> **Trademark Notice:** Unraid® is a registered trademark of Lime Technology, Inc. This project is not affiliated with, endorsed by, or sponsored by Lime Technology, Inc.
46
57
## Related Projects
68

79
This workspace may include:
8-
- **unraid-plugin-docs** ([mstrhakr/unraid-plugin-docs](https://github.com/mstrhakr/unraid-plugin-docs)) - Documentation repository (this site)
10+
- **plugin-docs** ([mstrhakr/plugin-docs](https://github.com/mstrhakr/plugin-docs)) - Documentation repository (this site)
911
- **compose_plugin** ([mstrhakr/compose_plugin](https://github.com/mstrhakr/compose_plugin), `dev` branch) - Refactored fork with modern patterns, real-world reference implementation
1012

1113
When working across both projects:
@@ -21,8 +23,9 @@ When working across both projects:
2123
- Internal links use relative paths without leading slash (e.g., `plg-file.md`)
2224
- Code blocks need language hints for syntax highlighting
2325
- Include explanatory text before code snippets, not just code comments
26+
- Use "Unraid®" with the registered trademark symbol at first mention in each document
2427

25-
## Key Unraid Concepts
28+
## Key Unraid® Concepts
2629

2730
| Concept | Key Points |
2831
|---------|-----------|
@@ -31,7 +34,7 @@ When working across both projects:
3134
| **Events** | Scripts in `event/` directory, blocking behavior warning |
3235
| **Persistence** | `/boot/config/plugins/` survives reboot; `/usr/local/emhttp/` is RAM |
3336
| **Settings** | Config files use `key="value"` format, read with `parse_plugin_cfg()` |
34-
| **Docker Labels** | Unraid-specific labels for webui integration (`net.unraid.docker.*`) |
37+
| **Docker Labels** | Unraid®-specific labels for webui integration (`net.unraid.docker.*`) |
3538

3639
## compose_plugin Reference Structure
3740

CNAME

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
unraid-plugin-docs.mstrhakr.com
1+
plugin-docs.mstrhakr.com

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Contributing to Unraid Plugin Documentation
22

3-
<a href="https://github.com/mstrhakr/unraid-plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Lockup_White.svg" alt="GitHub" height="40" align="right"></a>
3+
<a href="https://github.com/mstrhakr/plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Lockup_White.svg" alt="GitHub" height="40" align="right"></a>
44

55
Thank you for your interest in contributing! This documentation is a community effort, and we welcome all contributions.
66

README.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
# Unraid Plugin Development Documentation
1+
# Plugin Development Documentation for Unraid®
22

3-
> **The community-maintained guide to building plugins for Unraid OS**
3+
> **The community-maintained guide to building plugins for Unraid® OS**
4+
>
5+
> *Unraid® is a registered trademark of Lime Technology, Inc. This project is not affiliated with, endorsed by, or sponsored by Lime Technology, Inc.*
46
57
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
6-
[![Unraid](https://img.shields.io/badge/Unraid-6.9+-orange.svg)](https://unraid.net/)
8+
[![Works with Unraid®](https://img.shields.io/badge/Works_with-Unraid®_6.9+-orange.svg)](https://unraid.net/)
79
[![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](CONTRIBUTING.md)
8-
[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Funraid-plugin-docs.mstrhakr.com&count_bg=%23FF8C00&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Page+Views&edge_flat=false)](https://mstrhakr.goatcounter.com)
10+
[![Visitors](https://hits.seeyoufarm.com/api/count/incr/badge.svg?url=https%3A%2F%2Fplugin-docs.mstrhakr.com&count_bg=%23FF8C00&title_bg=%23555555&icon=&icon_color=%23E7E7E7&title=Page+Views&edge_flat=false)](https://mstrhakr.goatcounter.com)
911

1012
<p>
11-
<a href="https://github.com/mstrhakr/unraid-plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Lockup_White.svg" alt="View on GitHub" height="32"></a>
13+
<a href="https://github.com/mstrhakr/plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Lockup_White.svg" alt="View on GitHub" height="32"></a>
1214
&nbsp;&nbsp;
1315
<a href="https://github.com/features/copilot"><img src="assets/images/logos/GitHub%20Logos/GitHub_Copilot_Lockup_White.svg" alt="Built with GitHub Copilot" height="28"></a>
1416
&nbsp;&nbsp;
@@ -25,15 +27,15 @@
2527

2628
## 📖 About This Documentation
2729

28-
This is the **unofficial, community-driven** documentation for developing plugins for [Unraid OS](https://unraid.net/). The Unraid plugin system is powerful but has historically lacked comprehensive documentation. This project aims to fill that gap by providing clear, well-organized, and up-to-date resources for plugin developers.
30+
This is the **unofficial, community-driven** documentation for developing plugins for [Unraid® OS](https://unraid.net/). The Unraid® plugin system is powerful but has historically lacked comprehensive documentation. This project aims to fill that gap by providing clear, well-organized, and up-to-date resources for plugin developers.
2931

30-
> ⚠️ **Disclaimer**: This is not official Lime Technology documentation. While every effort is made to ensure accuracy, please verify critical information against official sources and existing plugins.
32+
> ⚠️ **Disclaimer**: This is not official Lime Technology documentation. Unraid® is a registered trademark of Lime Technology, Inc. This project is not affiliated with, endorsed by, or sponsored by Lime Technology, Inc. While every effort is made to ensure accuracy, please verify critical information against official sources and existing plugins.
3133
3234
---
3335

3436
## 🚀 Quick Start
3537

36-
New to Unraid plugin development? Start here:
38+
New to Unraid® plugin development? Start here:
3739

3840
1. **[Introduction to Plugins](docs/introduction.md)** - What are plugins and how do they work?
3941
2. **[Plugin File Structure](docs/plg-file.md)** - Anatomy of a `.plg` file
@@ -48,7 +50,7 @@ New to Unraid plugin development? Start here:
4850

4951
| Topic | Description |
5052
|-------|-------------|
51-
| [Introduction](docs/introduction.md) | Overview of the Unraid plugin system |
53+
| [Introduction](docs/introduction.md) | Overview of the Unraid® plugin system |
5254
| [PLG File Reference](docs/plg-file.md) | Complete reference for `.plg` XML structure |
5355
| [Page Files](docs/page-files.md) | Creating web UI pages (`.page` files) |
5456
| [Plugin Lifecycle](docs/lifecycle.md) | Installation, updates, and removal |
@@ -59,7 +61,7 @@ New to Unraid plugin development? Start here:
5961
| Topic | Description |
6062
|-------|-------------|
6163
| [Page Headers](docs/page-headers.md) | Menu, Title, Type, Icon, and more |
62-
| [Dynamix Markdown](docs/dynamix-markdown.md) | The form syntax used in Unraid UI |
64+
| [Dynamix Markdown](docs/dynamix-markdown.md) | The form syntax used in Unraid® UI |
6365
| [PHP Integration](docs/php-integration.md) | Using PHP in your pages |
6466
| [JavaScript & AJAX](docs/javascript.md) | Client-side scripting |
6567
| [CSS & Theming](docs/theming.md) | Styling your plugin UI |
@@ -95,7 +97,7 @@ New to Unraid plugin development? Start here:
9597

9698
## 🗂️ Plugin System Overview
9799

98-
At a high level, an Unraid plugin consists of:
100+
At a high level, an Unraid® plugin consists of:
99101

100102
```
101103
┌─────────────────────────────────────────────────────────────────┐
@@ -196,7 +198,7 @@ plugin version /var/log/plugins/myplugin.plg
196198

197199
## 🤝 Contributing
198200

199-
<a href="https://github.com/mstrhakr/unraid-plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Invertocat_White.svg" alt="GitHub" height="48" align="right"></a>
201+
<a href="https://github.com/mstrhakr/plugin-docs"><img src="assets/images/logos/GitHub%20Logos/GitHub_Invertocat_White.svg" alt="GitHub" height="48" align="right"></a>
200202

201203
This documentation is a community effort! Contributions are welcome:
202204

@@ -211,8 +213,8 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
211213
## 📜 Resources & Links
212214

213215
### Official Resources
214-
- [Unraid Forums](https://forums.unraid.net/) - The primary community hub
215-
- [Unraid Documentation](https://docs.unraid.net/) - Official docs
216+
- [Unraid® Forums](https://forums.unraid.net/) - The primary community hub
217+
- [Unraid® Documentation](https://docs.unraid.net/) - Official docs
216218
- [Plugin Support Forum](https://forums.unraid.net/forum/77-plugin-support/)
217219
- [Programming Forum](https://forums.unraid.net/forum/57-programming/)
218220

@@ -233,6 +235,6 @@ This documentation is licensed under [CC BY-SA 4.0](LICENSE). Code examples are
233235
---
234236

235237
<p align="center">
236-
<strong>Made with ❤️ by the Unraid community</strong><br>
238+
<strong>Made with ❤️ by the Unraid® community</strong><br>
237239
<a href="https://unraid.net/">unraid.net</a>
238240
</p>

_config.yml

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
theme: just-the-docs
2-
title: Unraid Plugin Development
3-
description: Community-maintained documentation for building Unraid plugins
4-
url: https://unraid-plugin-docs.mstrhakr.com
2+
title: Plugin Development Docs for Unraid®
3+
description: Community-maintained documentation for building plugins for Unraid®. Not affiliated with Lime Technology, Inc.
4+
url: https://plugin-docs.mstrhakr.com
55
baseurl: ""
66

77
# Enable search
@@ -17,12 +17,12 @@ back_to_top: true
1717
back_to_top_text: "Back to top"
1818

1919
# Footer content
20-
footer_content: "Unofficial community documentation. Not affiliated with Lime Technology."
20+
footer_content: "Unraid® is a trademark of Lime Technology, Inc. Not affiliated."
2121

2222
# GitHub Edit Link
2323
gh_edit_link: true
2424
gh_edit_link_text: "Edit this page on GitHub"
25-
gh_edit_repository: "https://github.com/mstrhakr/unraid-plugin-docs"
25+
gh_edit_repository: "https://github.com/mstrhakr/plugin-docs"
2626
gh_edit_branch: "main"
2727
gh_edit_source: docs
2828
gh_edit_view_mode: "edit"
@@ -40,7 +40,7 @@ logo: "/assets/images/logo.svg"
4040
# Aux links (top right)
4141
aux_links:
4242
"View on GitHub":
43-
- "https://github.com/mstrhakr/unraid-plugin-docs"
43+
- "https://github.com/mstrhakr/plugin-docs"
4444
"Unraid Forums":
4545
- "https://forums.unraid.net/"
4646

_includes/footer_custom.html

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
<div style="margin-top: 1rem; padding-top: 1rem; border-top: 1px solid var(--border-color); display: flex; align-items: center; justify-content: center; gap: 1rem; flex-wrap: wrap;">
2-
<a href="https://unraid.net/" style="display: inline-flex; align-items: center; opacity: 0.7; transition: opacity 0.2s;" title="Unraid OS">
3-
<img src="{{ '/assets/images/logos/Unraid%20Logos/UN-logotype-gradient.svg' | relative_url }}" alt="Unraid" style="height: 24px; width: auto; max-height: 24px;">
4-
</a>
2+
<a href="https://unraid.net/" style="opacity: 0.7; transition: opacity 0.2s; text-decoration: none;" title="Works with Unraid®">Works with Unraid®</a>
53
<span style="opacity: 0.5;">|</span>
6-
<a href="https://github.com/mstrhakr/unraid-plugin-docs" style="display: inline-flex; align-items: center; opacity: 0.7; transition: opacity 0.2s;">
4+
<a href="https://github.com/mstrhakr/plugin-docs" style="display: inline-flex; align-items: center; opacity: 0.7; transition: opacity 0.2s;">
75
<img src="{{ '/assets/images/logos/GitHub%20Logos/GitHub_Lockup_White.svg' | relative_url }}" alt="GitHub" style="height: 24px; width: auto; max-height: 24px;">
86
</a>
97
<span style="opacity: 0.5;">|</span>

assets/images/logo.svg

Lines changed: 166 additions & 1 deletion
Loading

assets/images/logos/README.md

Lines changed: 4 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,24 +14,16 @@ GitHub® and the GitHub logo are registered trademarks of GitHub, Inc. The GitHu
1414
- Do not use the logo to imply endorsement or sponsorship
1515
- Follow all guidelines at [brand.github.com](https://brand.github.com)
1616

17-
## Unraid Logo
17+
## Unraid® Trademark
1818

19-
**Source:** [Official Unraid Logo Assets](https://drive.google.com/drive/folders/1wafHPR2bRqMtDPRdLuY5unMK6emkBx5T) (linked from [unraid.net](https://unraid.net) footer under "Unraid Logos")
19+
Per the [Third-Party App Naming & Trademark Use Policy](https://unraid.net/policies) (effective October 1, 2025), we do not use Unraid® logos on this site. We use only plain text references with proper attribution.
2020

21-
Unraid® is a registered trademark of Lime Technology, Inc. The Unraid logo is provided by Lime Technology for community and documentation use.
22-
23-
### Usage Requirements
24-
- Do not modify the logo design or colors
25-
- Maintain the logo's aspect ratio
26-
- Do not use the logo to imply official endorsement unless authorized
27-
- Follow Lime Technology's brand guidelines
21+
Unraid® is a registered trademark of Lime Technology, Inc. This project is not affiliated with, endorsed by, or sponsored by Lime Technology, Inc.
2822

2923
---
3024

3125
## Disclaimer
3226

33-
This documentation project is a community resource and is not officially affiliated with, endorsed by, or sponsored by GitHub, Inc. or Lime Technology, Inc. All trademarks, logos, and brand names are the property of their respective owners.
34-
35-
The logos in this directory are included solely for educational and informational purposes within the context of Unraid plugin development documentation.
27+
This documentation project is a community resource and is not affiliated with, endorsed by, or sponsored by GitHub, Inc. or Lime Technology, Inc. All trademarks and brand names are the property of their respective owners.
3628

3729
If you are a representative of either company and have concerns about the use of these assets, please open an issue in this repository.

assets/images/logos/Unraid Logos/Social - Circle .svg

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)