Skip to content

docs: add Sportarr, Tracearr, and Watchsync pages; fix four pages against source - #72

Open
bakerboy448 wants to merge 2 commits into
Notifiarr:mainfrom
bakerboy448:docs/source-audit-2026-10
Open

bakerboy448 wants to merge 2 commits into
Notifiarr:mainfrom
bakerboy448:docs/source-audit-2026-10

Conversation

@bakerboy448

Copy link
Copy Markdown
Collaborator

Adds wiki pages for three integrations the site now supports, and corrects four existing pages against the client and website source.

Audited against notifiarr f86ebd4a (2026-10-22) and website-source ff74d60b (nightly, 2026-09-30).

New pages

  • Sportarr, Tracearr, and Watchsync, with nav entries. Trigger descriptions name the webhook event each one handles (api/v1/routes/notification/sportarr.php and watchsync.php).

Fixes

  • integrations/trash.md: document profile share codes (Verify, then Clone profile).
  • integrations/packagemanager.md: the client relays dpkg hooks and needs apt = true; it does not poll for updates. Unraid needs the agent script.
  • integrations/whisparr.md: trigger labels are "Site added" and "Site deleted" on the site.
  • client/troubleshooting.md: add the --fortune and --apthook flags.

Checked

  • markdownlint and cspell pass per file.
  • mkdocs build --strict passes (mkdocs-material 9.7.1 container).
  • Mediabot is the existing "Media Requests" page; no new page needed.

Comment thread docs/pages/client/troubleshooting.md Resolved
bakerboy448 and others added 2 commits October 29, 2026 17:50
…file codes, CLI hook flags, and APT relay behavior

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@bakerboy448
bakerboy448 force-pushed the docs/source-audit-2026-10 branch from 26bdb87 to ffb2bda Compare October 29, 2026 22:56
@bakerboy448
bakerboy448 enabled auto-merge (rebase) October 30, 2026 03:41

@qwen-pr-bot qwen-pr-bot Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Requesting changes on one item; the rest of the audit checks out.

Reviewed head ffb2bda against base 05a4327. Static review only; nothing was executed.

I read all eight files and cross-checked the testable claims against the two source repos you cite:

  • troubleshooting.md: --apthook and --fortune are both real. pkg/configfile/flags.go:51 defines the hook, start.go:131 dispatches it, and handleAptHook in cli.go:183 reads the dpkg payload from stdin, bails unless Config.EnableApt is set, and returns ErrUnsupport off Linux. --fortune prints from start.go:114, which runs before loadConfiguration, so "does not read your config file" is accurate. The deb ships the hook via init/linux/deb/etc/apt/apt.conf.d/999notifiarr, so your "deb installs the hook" line holds.
  • packagemanager.md: "relay hooks, don't poll; set apt = true" is right, and userscripts/unraid-notifiarr.sh exists at the linked path.
  • watchsync.md: all six triggers (userLogin, userUpdate, connectionError, syncWebhook, syncOverview, backup) match the watchsync trigger table, including backup, which I wasn't sure existed.
  • Nav ordering and trailing newlines are fine.

What blocks me: .cspell.json:words lists every other *-arr product in the wiki (Prowlarr, Lidarr, Radarr, Readarr, Reciperr, Sonarr, Bazarr, Whisparr) but not Sportarr, Tracearr, or Watchsync. The cspell pre-commit hook runs on all .md files and the Pre-commit workflow runs it on every PR, so the new pages will trip it, which contradicts the "cspell pass per file" in your description. Add Sportarr, Tracearr, and Watchsync (plus lowercase forms) to the words list. I couldn't run cspell in this static review, but given every sibling name is already in the dictionary, the compound ones are almost certainly flagged.

The Sportarr, Tracearr, and whisparr trigger labels live in the private website-source repo, so I've taken those on the audit rather than independently verifying them. Approving once the dictionary is updated.

@bakerboy448

Copy link
Copy Markdown
Collaborator Author

Ran cspell 8.17.3 with .cspell.json on sportarr.md, tracearr.md, and watchsync.md at ffb2bda: 3 files checked, 0 issues. The words are not flagged, so no dictionary entry is needed. Happy to add them if CI disagrees.

This branch has not been deployed

No deployments
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