Skip to content

docs: clarify user guidance and monitor setup - #128

Merged
nuxencs merged 2 commits into
developfrom
fm/mangarr-user-docs-clarity
Sep 16, 2026
Merged

nuxencs merged 2 commits into
developfrom
fm/mangarr-user-docs-clarity

Conversation

@nuxencs

@nuxencs nuxencs commented Sep 16, 2026

Copy link
Copy Markdown
Owner

Why

User-facing documentation included retry mechanics and provider implementation details that do not help with setup or recovery. Monitor examples also used inconsistent config paths.

What changed

  • Replace retry internals with recovery guidance that preserves skip, force, and rate-limit limitations.
  • Clarify monitor setup with a writable downloadLocation and consistent explicit config-directory examples.
  • Keep implementation-level retry details in maintainer docs and simplify Comix guidance.

Tests

  • Verified repository-local Markdown links and anchors with a local checker.
  • Verified mangarr download --help and mangarr monitor --help locally.
  • CI's offline Lychee check passed: 73 successful links, 0 errors across 149 links.
  • Lychee was unavailable locally, so no local Lychee run, live provider traffic, or real downloads were used.

@nuxencs nuxencs changed the title docs: simplify user guidance and clarify monitor setup docs: clarify user guidance and monitor setup Sep 16, 2026
@nuxencs
nuxencs merged commit 03cf7cd into develop Sep 16, 2026
2 checks passed
@nuxencs
nuxencs deleted the fm/mangarr-user-docs-clarity branch September 16, 2026 17:33
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.

1 participant