Initial documentation structure for Unraid plugin development

Author: mstrhakr

.github/workflows/pages.yml

@@ -0,0 +1,53 @@
+name: Deploy Jekyll site to Pages
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.1'
+          bundler-cache: true
+          
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+        
+      - name: Build with Jekyll
+        run: |
+          bundle install
+          bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+          
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -0,0 +1,40 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# Ruby / Jekyll
+_site/
+.sass-cache/
+.jekyll-cache/
+.jekyll-metadata
+vendor/
+.bundle/
+
+# Editor directories and files
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+Thumbs.db
+
+# Logs
+*.log
+
+# Temporary files
+tmp/
+temp/
+
+# Local development
+.env
+.env.local
+
+# Build outputs
+node_modules/
+dist/
+build/
+
+# Gem locks (for different environments)
+Gemfile.lock

CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to Unraid Plugin Documentation
+
+Thank you for your interest in contributing! This documentation is a community effort, and we welcome all contributions.
+
+## Ways to Contribute
+
+### Report Issues
+
+Found an error or something unclear? [Open an issue](../../issues) with:
+- A clear description of the problem
+- The page/section affected
+- Suggested correction (if you have one)
+
+### Submit Documentation
+
+Have knowledge to share? Pull requests are welcome:
+
+1. Fork the repository
+2. Create a feature branch (`git checkout -b docs/new-section`)
+3. Make your changes
+4. Submit a pull request
+
+### Review and Feedback
+
+- Review open pull requests
+- Test documentation against real plugins
+- Suggest improvements in discussions
+
+## Documentation Guidelines
+
+### Writing Style
+
+- **Be concise**: Plugin developers are busy
+- **Use examples**: Code speaks louder than words
+- **Be accurate**: Test commands and code before documenting
+- **Stay current**: Note version requirements when relevant
+
+### Formatting
+
+- Use proper Markdown formatting
+- Include code blocks with language hints:
+  ```php
+  <?php
+  // PHP code here
+  ?>
+  ```
+- Use tables for reference information
+- Include diagrams for complex concepts (ASCII art is fine)
+
+### Structure
+
+Each documentation page should have:
+
+1. **Title** - Clear H1 header
+2. **Introduction** - Brief overview of the topic
+3. **Content** - Main documentation
+4. **Examples** - Practical code examples
+5. **Next Steps** - Links to related topics
+
+### File Organization
+
+```
+docs/
+├── introduction.md      # Getting started
+├── plg-file.md          # PLG file reference
+├── page-files.md        # Page file reference
+├── events.md            # Event system
+├── filesystem.md        # File locations
+├── [topic].md           # Other topics
+```
+
+## Code of Conduct
+
+- Be respectful and inclusive
+- Focus on constructive feedback
+- Help newcomers learn
+- Give credit where due
+
+## Questions?
+
+- Open a [discussion](../../discussions) for questions
+- Check existing issues before creating new ones
+- Tag maintainers if you need help
+
+## License
+
+By contributing, you agree that your contributions will be licensed under the same license as the project (CC BY-SA 4.0 for documentation, MIT for code examples).

Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+gem "jekyll", "~> 4.3"
+gem "just-the-docs", "~> 0.8"
+gem "jekyll-seo-tag"
+gem "jekyll-sitemap"
+
+# Windows and JRuby does not include zoneinfo files
+platforms :mingw, :x64_mingw, :mswin, :jruby do
+  gem "tzinfo", ">= 1", "< 3"
+  gem "tzinfo-data"
+end
+
+# Performance-booster for watching directories on Windows
+gem "wdm", "~> 0.1", :platforms => [:mingw, :x64_mingw, :mswin]
+
+# Lock http_parser.rb for JRuby
+gem "http_parser.rb", "~> 0.6.0", :platforms => [:jruby]

LICENSE

@@ -0,0 +1,51 @@
+# Creative Commons Attribution-ShareAlike 4.0 International License
+
+This documentation is licensed under Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0).
+
+## You are free to:
+
+- **Share** — copy and redistribute the material in any medium or format
+- **Adapt** — remix, transform, and build upon the material for any purpose, even commercially
+
+## Under the following terms:
+
+- **Attribution** — You must give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
+
+- **ShareAlike** — If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original.
+
+- **No additional restrictions** — You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.
+
+## Full License Text
+
+The full license text is available at:
+https://creativecommons.org/licenses/by-sa/4.0/legalcode
+
+---
+
+## Code Examples License (MIT)
+
+Code examples within this documentation are provided under the MIT License:
+
+```
+MIT License
+
+Copyright (c) 2026 Unraid Plugin Documentation Contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+```