1111
1212---
1313
14- ## 🌐 [ ** Read the Documentation →** ] ( https://plugin-docs.mstrhakr.com/ )
14+ ## 🌐 [ ** Read the Documentation →** ] ( https://plugin-docs.mstrhakr.com/docs/ )
1515
1616---
1717
@@ -27,61 +27,68 @@ This is the **unofficial, community-driven** documentation for developing plugin
2727
2828New to Unraid® plugin development? Start here:
2929
30- 1 . ** [ Introduction to Plugins] ( docs/ introduction.md ) ** - What are plugins and how do they work?
31- 2 . ** [ Plugin File Structure] ( docs/ plg-file.md ) ** - Anatomy of a ` .plg ` file
32- 3 . ** [ Your First Plugin] ( docs/ getting-started.md ) ** - Step-by-step tutorial
33- 4 . ** [ Web UI Pages] ( docs/ page-files.md ) ** - Creating ` .page ` files for the web GUI
30+ 1 . ** [ Introduction to Plugins] ( https://plugin- docs.mstrhakr.com/docs/ introduction.html ) ** - What are plugins and how do they work?
31+ 2 . ** [ Plugin File Structure] ( https://plugin- docs.mstrhakr.com/docs/ plg-file.html ) ** - Anatomy of a ` .plg ` file
32+ 3 . ** [ Your First Plugin] ( https://plugin- docs.mstrhakr.com/docs/ getting-started.html ) ** - Step-by-step tutorial
33+ 4 . ** [ Web UI Pages] ( https://plugin- docs.mstrhakr.com/docs/ page-files.html ) ** - Creating ` .page ` files for the web GUI
3434
3535---
3636
3737## 📚 Documentation Index
3838
39+ ### Getting Started
40+
41+ | Topic | Description |
42+ | -------| -------------|
43+ | [ Introduction] ( https://plugin-docs.mstrhakr.com/docs/introduction.html ) | Overview of the Unraid® plugin system |
44+ | [ Your First Plugin] ( https://plugin-docs.mstrhakr.com/docs/getting-started.html ) | Step-by-step tutorial |
45+ | [ Example Plugins] ( https://plugin-docs.mstrhakr.com/docs/examples.html ) | Real-world plugin references |
46+
3947### Core Concepts
4048
4149| Topic | Description |
4250| -------| -------------|
43- | [ Introduction ] ( docs/introduction.md ) | Overview of the Unraid® plugin system |
44- | [ PLG File Reference ] ( docs/plg-file.md ) | Complete reference for ` .plg ` XML structure |
45- | [ Page Files ] ( docs/page-files.md ) | Creating web UI pages ( ` .page ` files) |
46- | [ Plugin Lifecycle ] ( docs/lifecycle.md ) | Installation, updates, and removal |
47- | [ File System Layout ] ( docs/filesystem.md ) | Where files go and why |
51+ | [ PLG File Reference ] ( https://plugin- docs.mstrhakr.com/docs/plg-file.html ) | ` .plg ` installer format & metadata |
52+ | [ Page Files ] ( https://plugin- docs.mstrhakr.com/docs/page-files.html ) | Creating web UI pages ( ` .page ` files) |
53+ | [ File System Layout ] ( https://plugin-docs.mstrhakr.com/docs/filesystem.html ) | Where plugin files live |
54+ | [ Event System ] ( https://plugin- docs.mstrhakr.com/docs/events.html ) | Responding to array and system events |
55+ | [ Plugin Command ] ( https://plugin- docs.mstrhakr.com/docs/plugin-command.html ) | Using the ` plugin ` CLI tool |
4856
49- ### Web UI Development
57+ ### UI Development
5058
5159| Topic | Description |
5260| -------| -------------|
53- | [ Page Headers ] ( docs/page-headers.md ) | Menu, Title, Type, Icon, and more |
54- | [ Dynamix Markdown ] ( docs/dynamix-markdown.md ) | The form syntax used in Unraid® UI |
55- | [ PHP Integration ] ( docs/php-integration.md ) | Using PHP in your pages |
56- | [ JavaScript & AJAX ] ( docs/javascript.md ) | Client-side scripting |
57- | [ CSS & Theming ] ( docs/theming.md ) | Styling your plugin UI |
61+ | [ UI Development ] ( https://plugin-docs.mstrhakr.com/docs/ui/index.html ) | Overview of UI-related docs |
62+ | [ JavaScript Patterns ] ( https://plugin- docs.mstrhakr.com/docs/ui/javascript-patterns.html ) | Common jQuery patterns & AJAX |
63+ | [ Form Controls ] ( https://plugin- docs.mstrhakr.com/docs/ui/form-controls.html ) | Standard input elements and styling |
64+ | [ Tab Pages ] ( https://plugin- docs.mstrhakr.com/docs/ui/tab-pages.html ) | Multi-tab settings pages |
65+ | [ Icons & Styling ] ( https://plugin- docs.mstrhakr.com/docs/ui/icons-and-styling.html ) | FontAwesome, themes, and CSS |
5866
59- ### Events & System Integration
67+ ### Advanced Topics
6068
6169| Topic | Description |
6270| -------| -------------|
63- | [ Event System] ( docs/events.md ) | Responding to array start/stop, Docker, etc. |
64- | [ Configuration Files] ( docs/config-files.md ) | Storing and reading plugin settings |
65- | [ Shell Scripts] ( docs/shell-scripts.md ) | Background tasks and automation |
66- | [ Docker Integration] ( docs/docker-integration.md ) | Working with Docker containers |
71+ | [ Advanced Topics] ( https://plugin-docs.mstrhakr.com/docs/advanced/index.html ) | Advanced plugin development guidance |
72+ | [ Docker Integration] ( https://plugin-docs.mstrhakr.com/docs/advanced/docker-integration.html ) | Docker API & container management |
73+ | [ Update Mechanisms] ( https://plugin-docs.mstrhakr.com/docs/advanced/update-mechanisms.html ) | Version checks and auto-updates |
74+ | [ Debugging Techniques] ( https://plugin-docs.mstrhakr.com/docs/advanced/debugging-techniques.html ) | Logging, error handling, dev tools |
75+ | [ Testing] ( https://plugin-docs.mstrhakr.com/docs/advanced/testing.html ) | Testing strategies and tools |
6776
68- ### Packaging & Distribution
77+ ### Distribution
6978
7079| Topic | Description |
7180| -------| -------------|
72- | [ Package Building ] ( docs/packaging.md ) | Creating ` .txz ` packages |
73- | [ Versioning ] ( docs/versioning.md ) | Version strategies and update checking |
74- | [ Community Applications ] ( docs/community-apps.md ) | Publishing to the CA App Store |
75- | [ Best Practices ] ( docs/best-practices.md ) | Tips from experienced developers |
81+ | [ Distribution & Publishing ] ( https://plugin- docs.mstrhakr.com/docs/distribution/index.html ) | How to ship and support your plugin |
82+ | [ Community Applications ] ( https://plugin- docs.mstrhakr.com/docs/distribution/community-applications.html ) | Publishing to CA |
83+ | [ Hosting ] ( https://plugin-docs.mstrhakr.com/docs/distribution/hosting.html ) | Hosting plugin files |
84+ | [ Support ] ( https://plugin-docs.mstrhakr.com/docs/distribution/support.html ) | Supporting users |
7685
7786### Reference
7887
7988| Topic | Description |
8089| -------| -------------|
81- | [ Plugin Command] ( docs/plugin-command.md ) | Using the ` plugin ` CLI tool |
82- | [ API Reference] ( docs/api-reference.md ) | Available PHP functions and variables |
83- | [ Example Plugins] ( docs/examples.md ) | Links to well-documented plugins |
84- | [ Troubleshooting] ( docs/troubleshooting.md ) | Common issues and solutions |
90+ | [ Plugin Command] ( https://plugin-docs.mstrhakr.com/docs/plugin-command.html ) | Using the ` plugin ` CLI tool |
91+ | [ Example Plugins] ( https://plugin-docs.mstrhakr.com/docs/examples.html ) | Links to well-documented plugins |
8592
8693---
8794
@@ -153,7 +160,7 @@ Plugins can respond to system events by placing executable scripts in their `eve
153160| ` stopped ` | Array has stopped |
154161| ` poll_attributes ` | SMART data polled |
155162
156- See [ Event System] ( docs/events.md ) for full details.
163+ See [ Event System] ( docs/events.html ) for full details.
157164
158165---
159166
@@ -188,7 +195,7 @@ plugin version /var/log/plugins/myplugin.plg
188195
189196## 🤝 Contributing
190197
191- <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 >
198+ <a href =" https://github.com/docs/ mstrhakr/plugin-docs " ><img src =" assets/images/logos/GitHub%20Logos/GitHub_Invertocat_White.svg " alt =" GitHub " height =" 48 " align =" right " ></a >
192199
193200This documentation is a community effort! Contributions are welcome:
194201
@@ -203,17 +210,20 @@ See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
203210## 📜 Resources & Links
204211
205212### Official Resources
213+
206214- [ Unraid® Forums] ( https://forums.unraid.net/ ) - The primary community hub
207215- [ Unraid® Documentation] ( https://docs.unraid.net/ ) - Official docs
208216- [ Plugin Support Forum] ( https://forums.unraid.net/forum/77-plugin-support/ )
209217- [ Programming Forum] ( https://forums.unraid.net/forum/57-programming/ )
210218
211219### Community Developer Resources
212- - [ Community Applications Plugin] ( https://github.com/Squidly271/community.applications ) - The app store for plugins
213- - [ Dynamix Plugins] ( https://github.com/bergware/dynamix ) - Reference implementations by @bonienl
220+
221+ - [ Community Applications Plugin] ( https://github.com/docs/Squidly271/community.applications ) - The app store for plugins
222+ - [ Dynamix Plugins] ( https://github.com/docs/bergware/dynamix ) - Reference implementations by @bonienl
214223- [ Plugin Template Discussions] ( https://forums.unraid.net/topic/52623-plugin-system-documentation/ )
215224
216225### Historical References
226+
217227- [ How does the plugin system work?] ( https://forums.unraid.net/topic/33322-how-does-the-plugin-system-work-documentation-added-wip/ ) - Original documentation (partially outdated)
218228
219229---
0 commit comments