Skip to content

docs: add PLUGINS.md — plugin system overview + getting started#721

Closed
shuff57 wants to merge 1 commit into
Listenarrs:canaryfrom
shuff57:docs/plugins-md
Closed

docs: add PLUGINS.md — plugin system overview + getting started#721
shuff57 wants to merge 1 commit into
Listenarrs:canaryfrom
shuff57:docs/plugins-md

Conversation

@shuff57

@shuff57 shuff57 commented Jul 2, 2026

Copy link
Copy Markdown

Adds a top-level PLUGINS.md documenting Listenarr's runtime plugin system.

What it covers

  • What the plugin system is: repositories are a catalog you install from selectively, not a bundle — adding a repository populates the Settings → Plugins list, and you install only what you want.
  • How install / update / uninstall work (and that the app restarts to load changes).
  • The plugin package layout (plugin.json + optional backend .dll + optional ui/ bundle) and that plugins own their own data without touching the core schema.
  • How to run your own repository (the catalog JSON shape).
  • A getting-started pointer to an example plugin catalog: https://github.com/shuff57/listenarr-plugins

Notes

  • Docs only — one new file, no code changes.
  • This documents the runtime plugin host (see the plugin-system work / feat(plugins): runtime-installable plugin system (loader + manager) #713). If the plugin host isn't in canary yet, this can land alongside/after it.
  • The example catalog referenced is a personal/community repo; happy to adjust the wording or swap in a neutral example if you'd prefer.

🤖 Generated with Claude Code

Documents Listenarr's runtime plugin system: repositories are a catalog you
install from selectively (not a bundle), how install/update/uninstall work, the
plugin package layout, and how to run your own repository. Includes a getting-
started pointer to an example plugin catalog.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@shuff57 shuff57 requested a review from a team July 2, 2026 16:46
@therobbiedavis

Copy link
Copy Markdown
Collaborator

@shuff57 Why not add into #713

@shuff57

shuff57 commented Jul 2, 2026 via email

Copy link
Copy Markdown
Author

@shuff57

shuff57 commented Jul 2, 2026

Copy link
Copy Markdown
Author

Folded into #713 (the plugin-system PR) — the docs belong with the feature. Closing this standalone docs PR.

@shuff57 shuff57 closed this Jul 2, 2026
@shuff57 shuff57 deleted the docs/plugins-md branch July 2, 2026 17:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants