| id | contributing |
|---|---|
| slug | /contributing |
| description | Contributing to Maintainerr in some way? Look no further. All you need to get started is here in this page. |
| title | Contributing |
Thanks for helping improve the Maintainerr documentation.
Guides, walkthroughs, corrections, screenshots, wording improvements, and structural cleanup are all useful contributions.
Install dependencies:
npm installStart the local development server:
npm startCreate a production build:
npm run buildServe the production build locally:
npm run servedocs/contains the main documentation pagesblog/contains walkthroughs and blog postsstatic/contains static assets such as images and other files served directlysrc/contains site-level styling and React-based customizationsdocusaurus.config.jscontains the site configurationsidebars.jscontains the docs navigation structure
- Keep pull requests focused and easy to review
- Prefer native Markdown and Docusaurus syntax over raw HTML when possible
- Use
media serverunless a page is describing Plex-specific or Jellyfin-specific behavior - Use
Seerrinstead of older separate Overseerr or Jellyseerr terminology - Verify screenshots, labels, and workflow wording against the current app behavior before merging
- Run
npm run buildbefore opening a pull request when you make structural or formatting changes
If you are making a larger docs change, it is usually better to split content cleanup, structural changes, and visual changes into separate pull requests.
If you want to contribute to the Maintainerr application itself, use the upstream app repository guide:
That guide covers:
- development environment setup
- branch and pull request expectations
- Conventional Commits
- code formatting and review expectations
- UI text guidelines
- AI-assisted contribution expectations
If you are unsure where to start, open an issue or ask in the community: