feat: revamp all application pages#452
Merged
augustuen merged 13 commits intoJun 27, 2026
Merged
Conversation
bakerboy448
force-pushed
the
audit/2026-06-wiki-revamp
branch
from
011178b to
9203f46
Compare
bakerboy448
force-pushed
the
audit/2026-06-wiki-revamp
branch
from
9203f46 to
129ea78
Compare
Cross-referenced every documented option, setting, env var, integration, and health check against the current Sonarr v4 main-branch source. Edits made to 15 pages. Key categories of change: - environment-variables.md: corrected config-key names to match the literal strings inside ConfigFileProvider.cs GetValueX() calls; added new options present in code (e.g. TrustCgnatIpAddresses). - system.md: removed 6 obsolete health checks (.NET Framework / Mono / SQLite version / Mono Legacy TLS) no longer present in v4; added the health checks newly present in code (ApiKeyValidationCheck, IndexerDownloadClientCheck, NotificationStatusCheck, RecyclingBinCheck, MetadataCheck deprecation, etc.); added missing anchor IDs matching HealthCheck.WikiUrlFragment. - custom-scripts.md: cross-referenced per-event Sonarr_* env vars against CustomScript.cs override methods. - supported.md: cross-referenced indexer / download client / notification / import list / metadata class names against current source tree. WikiJS frontmatter preserved on every page. date field updated to 2026-06-07T00:00:00.000Z.
Cross-referenced every documented option, setting, env var, integration, and health check against the current Radarr develop-branch source code. Edits made to 14 pages. Key categories of change: - environment-variables.md: corrected config-key names to match the literal strings inside ConfigFileProvider.cs GetValueX() calls; added / removed rows to match current option classes. - system.md: aligned health-check entries with the current src/NzbDrone.Core/HealthCheck/Checks/ classes (anchor IDs match WikiUrlFragment values in code). - custom-scripts.md: cross-referenced per-event Radarr_* env vars against CustomScript.cs override methods. - supported.md: cross-referenced indexer / download client / notification / import list / metadata class names against current source tree. - settings.md: verified naming tokens against FileNameBuilder.cs tokenHandlers[] entries (source-of-truth for valid tokens). WikiJS frontmatter preserved on every page. date field updated to 2026-06-07T00:00:00.000Z.
Cross-referenced every documented option, setting, env var, integration, naming token, and health check against the current Lidarr develop-branch source code. Edits made to 22 pages. Key categories of change: - environment-variables.md: corrected config-key names to match the literal strings inside ConfigFileProvider.cs GetValueX() calls. - system.md: aligned health-check entries with current src/NzbDrone.Core/HealthCheck/Checks/ classes. - custom-scripts.md: cross-referenced per-event Lidarr_* env vars against CustomScript.cs override methods. - supported.md: cross-referenced indexer / download client / notification / import list / metadata class names. Lidarr-specific ImportLists (Spotify, LastFm, MusicBrainz, etc.) verified. - plugins.md: aligned plugin install/load mechanism documentation with src/NzbDrone.Common/Composition/Plugin*.cs and src/Lidarr.Api.V1/System/Plugins/. Page maintains the develop-only nature of the plugin system (master / stable releases do NOT ship with plugins). - naming-guide.md: verified every documented naming token against FileNameBuilder.cs tokenHandlers[] entries. - faq.md: verified download decision priority order (Quality / Custom Format Score / Protocol / Indexer Priority / Seeds / Age) against src/NzbDrone.Core/DecisionEngine/DownloadDecisionComparer.cs. - installation/linux.md: required runtime apt dependencies (mediainfo, libchromaprint-tools) preserved alongside curl, sqlite3, and wget. WikiJS frontmatter preserved on every page. date field updated to 2026-06-07T00:00:00.000Z.
Cross-referenced every documented option, setting, env var, integration,
Cardigann YAML field, and health check against the current Prowlarr
develop-branch source code. Edits made to 13 pages.
Key categories of change:
- environment-variables.md: corrected config-key names to match the
literal strings inside ConfigFileProvider.cs GetValueX() calls.
- system.md: aligned health-check entries with current
src/NzbDrone.Core/HealthCheck/Checks/ classes.
- custom-scripts.md: cross-referenced per-event Prowlarr_* env vars
against CustomScript.cs override methods (limited set:
OnHealthIssue / OnHealthRestored / OnApplicationUpdate / OnGrab).
- supported.md: cross-referenced built-in Application sync targets
against src/NzbDrone.Core/Applications/ (LazyLibrarian, Lidarr,
Mylar, Radarr, Readarr, Sonarr, Whisparr). External tools that
implement the protocols on their side were preserved.
- cardigann-yml-definition.md: aligned YAML schema documentation
with src/NzbDrone.Core/Indexers/Definitions/Cardigann/
Cardigann*.cs definitions.
- postgres-setup.md: cosmetic markdown list-continuation
indentation fixes.
- installation/reverse-proxy.md: added per-indexer Newznab/Torznab
Apache exclusion path /prowlarr/[0-9]+/api (matches the
{id:int}/api route at NewznabController.cs:58).
NOT touched: supported-indexers.md (auto-generated by
.github/workflows/prowlarr-ci.yml — wiki is regenerated from build).
WikiJS frontmatter preserved on every page. date field updated to
2026-06-07T00:00:00.000Z.
for more information, see https://pre-commit.ci
…pace) - Add `text` language to filesystem-tree fenced code blocks in lidarr/tips-and-tricks.md and lidarr/importing-existing-library.md (4 MD040 violations resolved). - Pre-commit autofix swept trailing whitespace + missing EOF newlines across 10 lidarr files touched by the audit.
- docker-guide.md: seperated → separated. - lidarr/importing-existing-library.md: complete truncated word "thi" → "this page" on the See-also bullet; "mis-linked" → "mismatched" (typos.toml does not allowlist the "mis" prefix). - lidarr/import-troubleshooting.md: complete truncated word "succes" → "success rate" on the Picard tools entry. Both truncations originated in audit-subagent-edited content. The typos flagged on lidarr files are AI-introduced; the docker-guide.md typo predates this PR but was not previously caught.
bakerboy448
force-pushed
the
audit/2026-06-wiki-revamp
branch
from
129ea78 to
06aaa30
Compare
bakerboy448
changed the title
Contributor
Author
|
LGTM.. @augustuen |
Document the singular {Custom Format:FormatName} token (FormatName is a
placeholder for an actual Custom Format name; outputs nothing unless that
format exists, matched the release, and has "Include Custom Format when
Renaming" enabled) and correct the {Custom Formats} filter description
(it filters by Custom Format name, not by release profile).
Addresses the v4 rename-help confusion raised in Sonarr issue 8742.
Replace the stale "written for Postgres 14, reported working 15-17" note with an accurate supported-version statement (PostgreSQL 14-18 via Npgsql; PG13 reached EOL in November 2025) and bump the example image, container name, volume path, host, and Radarr's connection-string examples from 14 to 17 -- matching the revamped Lidarr page. Also fixes "was been created" grammar and removes Radarr's duplicate MovieFiles_Id_seq setval statement.
Mirror the Sonarr rename-token clarification. Radarr: document the
singular {Custom Format:FormatName} token (placeholder for a real format
name; empty unless that format exists, matched, and is enabled for
renaming) and the {Custom Formats} include/exclude name filter. Lidarr:
make the {Custom Format} placeholder explicit (Lidarr's {Custom Formats}
has no name filter, so none is documented there).
Verified against each app's FileNameBuilder.cs.
Match the Sonarr/Radarr/Prowlarr update: add an accurate supported-version note (PostgreSQL 14-18 via Npgsql; PG13 EOL Nov 2025), bump the example image/container/volume/host from 14 to 17, fix "was been created" grammar, and add the missing semicolons to the seed-data DELETE block.
1 task
augustuen
requested changes
Jun 27, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Code-grounded audit of every Servarr wiki page against current app source code, applied as one commit per app.
main(v4)developdevelopdevelopMethodology
For each of 103 wiki pages, a per-page audit subagent:
ConfigFileProvider.csGetValueX("Key", default)calls for env vars,FileNameBuilder.cstokenHandlers[...]for naming tokens,src/NzbDrone.Core/HealthCheck/Checks/*.csclasses for system warnings,CustomScript.csoverride methods for per-event env vars, etc.).HealthCheck.WikiUrlFragment.39 of 103 pages returned "no discrepancies found" and were left untouched.
Examples of changes
LOG__DBENABLEDrow's Config Option column corrected fromDbEnabled(Options-class property name) toLogDbEnabled(literal string insideGetValueBoolean("LogDbEnabled", ...)atConfigFileProvider.cs:243).TrustCgnatIpAddresses(AuthOptions.cs+ConfigFileProvider.cs:480).Invalid API Key(ApiKeyValidationCheck.cs),Indexer Download Client is Invalid(IndexerDownloadClientCheck.cs),Cannot Write to Recycle Bin(RecyclingBinCheck.cs),Notifications are unavailable due to failures(NotificationStatusCheck.cs),Metadata Consumer is deprecated(MetadataCheck.csKometa), and others.{#wiki-url-fragment}anchors added to matchHealthCheck.WikiUrlFragmentvalues in code, so in-app "Wiki" buttons deep-link to the right section.FileNameBuilder.cstokenHandlers[...]dictionaries.Host→X-Forwarded-Host(matchesASP.NET CoreForwardedHeadersmiddleware behavior inStartup.cs:~62-64across all 4 apps).Per-app commit messages list the specific categories of change.
Caveats — please read before merging
This is an AI-assisted audit. Per-page subagent edits were eyeballed for known failure classes in a self-review pass on the contributor's fork before opening this PR. Two specific failure modes were caught and corrected, and one is worth flagging:
Caught + corrected:
lidarr/installation/linux.md) had its runtimeapt installline silently truncated by a subagent — system-level deps (mediainfo,libchromaprint-tools) are required by Lidarr at runtime but aren't visible in C# source, so the subagent had no way to confirm they were still needed. Restored.sonarr/installation/freebsd.md) had its documented default data dir changed to/var/db/sonarrbased on FreeBSDhier(7)conventions — but the actual default is set by the FreeBSD port'src.dscript, not in Sonarr's repo. No verifiable source, so reverted.Worth flagging:
Out of scope
prowlarr/supported-indexers.md— auto-regenerated by.github/workflows/prowlarr-ci.yml; not touched.Internal private-review
This PR was preceded by an internal private-review PR on the contributor's fork (
bakerboy448/ServarrWiki#2), where the working tree was inspected and the two failure-class corrections above were applied before opening upstream.Treat findings as a starting point for human review rather than authoritative changes.
🤖 Generated with Claude Code
Update — Postgres setup + Custom Format rename tokens
Added on top of the audit:
sonarr,radarr,prowlarr,whisparrpostgres-setup.md): bumped the example image topostgres:17; replaced the stale "written for Postgres 14 / reported 15-17" note with an accurate supported-version statement (PostgreSQL 14-18 via Npgsql; PG 13 reached EOL in November 2025); and fixed defects (Whisparr missingDELETEsemicolons, Radarr duplicateMovieFiles_Id_seqsetval, "was been created" grammar). Lidarr already carried the full revamp.sonarr/settings.md,radarr/settings.md,lidarr/naming-guide.md): clarified{Custom Format:FormatName}(a placeholder for a real Custom Format name; empty unless that format exists, matched, and has "Include Custom Format when Renaming" enabled) and documented the{Custom Formats}include/exclude name filter for Sonarr/Radarr (Lidarr has none). Verified against each app FileNameBuilder.cs. Addresses the v4 rename-help confusion in Sonarr issue 8742.Supersedes
These open PRs are superseded by this revamp (their target pages were rewritten here):
postgres-setup.mdre-indent (page fully rewritten + bumped topostgres:17here){MediaInfo BestAudioCodec}, a token not present in Radarrdevelopsource