Plundarr Developer Chart Room 🏴‍☠️

Welcome aboard the developer documentation for Plundarr and its generator, Maraudarr. These charts explain how the Python application turns a service catalog into one comment-rich Docker Compose deployment without trampling existing user configuration.

Choose Yer Route 🧭

Destination	Best for
Maraudarr overview	Understanding responsibilities and source layout
Architecture	Following data from CLI input to generated files
Add a service	Extending the selectable service catalog safely
Documentation style	Writing useful public docstrings and private-helper notes
Testing	Selecting the right validation voyage
Python reference	Looking up public classes and functions from source

Note

Plundarr is the generated deployment. Maraudarr is the short-lived Python generator that selects, renders, validates, and writes that deployment.

Documentation Boundaries 📚

This site owns code-adjacent developer documentation and the version-matched Python reference. User deployment routes and broader fleet guidance remain in Plundarrpedia, which links back here rather than copying generated API pages.

The static HTML is generated during validation and deployment. Only the Markdown sources, MkDocs configuration, and pinned documentation dependencies belong in Git; the generated site/ directory does not.