Skip to content

Commit 00d4cd5

Browse files
committed
feat: enhance documentation with Unraid Plugin Template details and tips for new users
1 parent 00a4b1f commit 00d4cd5

3 files changed

Lines changed: 29 additions & 3 deletions

File tree

docs/build-and-packaging.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,9 @@ esac
264264
265265
<img src="../assets/images/logos/GitHub%20Logos/GitHub_Invertocat_White.svg" alt="GitHub" height="40" align="right">
266266
267+
{: .tip }
268+
> **Starting fresh?** The [Unraid Plugin Template](https://github.com/dkaser/unraid-plugin-template) includes a complete GitHub Actions workflow out of the box—just enable Actions and create a release.
269+
267270
{: .note }
268271
> See the [DocTest plugin CI/CD workflow](https://github.com/mstrhakr/plugin-docs/blob/main/.github/workflows/plugin-release.yml) for a complete working example used by this documentation project.
269272

docs/examples.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,29 @@ Learning from existing plugins is one of the best ways to understand Unraid plug
1313
>
1414
> ![Example plugins](../assets/images/screenshots/example-plugins.png)
1515
16+
## Starting From a Template
17+
18+
### Unraid Plugin Template (by @dkaser)
19+
20+
The best way to start a new plugin. A GitHub template repository with everything you need.
21+
22+
- **Repository**: [dkaser/unraid-plugin-template](https://github.com/dkaser/unraid-plugin-template)
23+
- **Good for**: New plugin development, proper project structure, CI/CD setup
24+
25+
**Key features:**
26+
- GitHub Actions workflow for automated builds and releases
27+
- Code quality tools (phpstan for bug detection, php-cs-fixer for formatting)
28+
- Automated `customize.sh` script for quick setup
29+
- Proper YYYY.MM.DD versioning with same-day release support
30+
- diagnostics.json support for troubleshooting
31+
- commitlint for consistent commit messages
32+
33+
**How to use:**
34+
1. Click "Use this template" on GitHub
35+
2. Run `./customize.sh` to personalize
36+
3. Enable GitHub Actions in repository settings
37+
4. Create a release to build your first package
38+
1639
## Recommended for Learning
1740

1841
### Dynamix Plugins (by @bonienl)

docs/getting-started.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,10 @@ mermaid: true
1010
{: .note }
1111
> Unraid® is a registered trademark of Lime Technology, Inc. This documentation is not affiliated with Lime Technology, Inc.
1212
13-
This tutorial walks you through creating a simple "Hello World" Unraid plugin. You can follow along step-by-step to understand how plugins are structured, or start from a template repository to move faster.
13+
This tutorial walks you through creating a simple "Hello World" Unraid plugin. You can follow along step-by-step to understand how plugins are structured, or use a template repository to move faster.
1414

15-
## Template Repository
16-
https://github.com/dkaser/unraid-plugin-template
15+
{: .tip }
16+
> **Want to skip the manual setup?** The [Unraid Plugin Template](https://github.com/dkaser/unraid-plugin-template) provides a ready-to-use starting point with GitHub Actions, code quality tools, and automated versioning. Click "Use this template" on GitHub, run the `customize.sh` script, and you're ready to go.
1717
1818
## What We'll Build
1919

0 commit comments

Comments
 (0)