You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update documentation and branding for Unraid® plugin development
- Changed title and description in _config.yml to reflect Unraid® branding and clarify community affiliation.
- Updated footer content to include trademark information for Unraid®.
- Modified footer_custom.html to replace logo with text reference to Unraid®.
- Revised README.md in logos directory to clarify trademark usage and compliance with Unraid® policies.
- Removed unused Unraid® logo SVG files to streamline assets.
- Updated attributions.md to reflect proper trademark usage for Unraid®.
- Adjusted community-applications.md and getting-started.md to include Unraid® branding and clarify non-affiliation.
- Enhanced introduction.md to specify Unraid® branding and provide a clearer definition of plugins.
- Revised index.md to emphasize community-maintained documentation and Unraid® trademark.
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+6-3Lines changed: 6 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,8 @@
1
1
# Copilot Instructions for unraid-plugin-docs
2
2
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.
4
6
5
7
## Related Projects
6
8
@@ -21,8 +23,9 @@ When working across both projects:
21
23
- Internal links use relative paths without leading slash (e.g., `plg-file.md`)
22
24
- Code blocks need language hints for syntax highlighting
23
25
- Include explanatory text before code snippets, not just code comments
26
+
- Use "Unraid®" with the registered trademark symbol at first mention in each document
24
27
25
-
## Key Unraid Concepts
28
+
## Key Unraid® Concepts
26
29
27
30
| Concept | Key Points |
28
31
|---------|-----------|
@@ -31,7 +34,7 @@ When working across both projects:
31
34
|**Events**| Scripts in `event/` directory, blocking behavior warning |
32
35
|**Persistence**|`/boot/config/plugins/` survives reboot; `/usr/local/emhttp/` is RAM |
33
36
|**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.*`) |
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.
29
31
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.
31
33
32
34
---
33
35
34
36
## 🚀 Quick Start
35
37
36
-
New to Unraid plugin development? Start here:
38
+
New to Unraid® plugin development? Start here:
37
39
38
40
1.**[Introduction to Plugins](docs/introduction.md)** - What are plugins and how do they work?
39
41
2.**[Plugin File Structure](docs/plg-file.md)** - Anatomy of a `.plg` file
@@ -48,7 +50,7 @@ New to Unraid plugin development? Start here:
48
50
49
51
| Topic | Description |
50
52
|-------|-------------|
51
-
|[Introduction](docs/introduction.md)| Overview of the Unraid plugin system |
53
+
|[Introduction](docs/introduction.md)| Overview of the Unraid® plugin system |
52
54
|[PLG File Reference](docs/plg-file.md)| Complete reference for `.plg` XML structure |
53
55
|[Page Files](docs/page-files.md)| Creating web UI pages (`.page` files) |
54
56
|[Plugin Lifecycle](docs/lifecycle.md)| Installation, updates, and removal |
@@ -59,7 +61,7 @@ New to Unraid plugin development? Start here:
59
61
| Topic | Description |
60
62
|-------|-------------|
61
63
|[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 |
63
65
|[PHP Integration](docs/php-integration.md)| Using PHP in your pages |
Copy file name to clipboardExpand all lines: assets/images/logos/README.md
+4-12Lines changed: 4 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,24 +14,16 @@ GitHub® and the GitHub logo are registered trademarks of GitHub, Inc. The GitHu
14
14
- Do not use the logo to imply endorsement or sponsorship
15
15
- Follow all guidelines at [brand.github.com](https://brand.github.com)
16
16
17
-
## Unraid Logo
17
+
## Unraid® Trademark
18
18
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.
20
20
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.
28
22
29
23
---
30
24
31
25
## Disclaimer
32
26
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.
36
28
37
29
If you are a representative of either company and have concerns about the use of these assets, please open an issue in this repository.
0 commit comments