Repository navigation
Show the web interface in the README - #27
Merged
Merged
Conversation
The page said specials are not supported, though a special can be pinned as S00E01, as the table above it and the TVP notes say. Only season rules are limited to numbered seasons.
The README opens with the logo and a screenshot of the queue page, and the section on connecting Sonarr and Radarr shows the Setup page that lists the values. Each image has a light and a dark version, which GitHub picks by the reader's theme. The screenshots are rendered from sample data. The text is reordered for a first-time reader: what magnetowid does, the supported sites, what you get, then the quick start as three numbered steps with the .env settings in a table. The web interface's pages get a table too, and the documentation links now include overrides and limitations.
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
1 participant
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.
Redesigns the README around the web interface, and corrects a stale sentence in the docs.
.envsettings in a table.The overrides section of
docs/usage.mdsaid specials are not supported. A special can be pinned asS00E01; only season rules are limited to numbered seasons, and the page now says so.The rendered README is easiest to judge on the branch: https://github.com/combor/magnetowid/blob/readme-refresh/README.md
Tested: the README rendered through GitHub's markdown API and viewed in Chromium in light and dark at desktop and phone widths; every linked docs anchor checked against its heading;
make test; Codex review.