Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update whisparr.md #196

Merged
merged 1 commit into from
Mar 9, 2023
Merged

Update whisparr.md #196

merged 1 commit into from
Mar 9, 2023

Conversation

RaneyDazed
Copy link
Contributor

Filled in info on whisparr, added links to docs and GH/docker hub.

Filled in info on whisparr, added links to docs and GH/docker hub.
@maximuskowalski
Copy link
Collaborator

I particularly liked this suggestion from my consultation with ChatGPT....

In the "URL" section, clarify that users should replace "yourdomain.com" with their actual domain name

Here are the other suggestions from the oracle.

The documentation looks good overall, but here are some suggestions to improve it:

  • Include a brief description of what Usenet and BitTorrent are, as not everyone may be familiar with these terms.
  • In the "What is it?" section, provide a more concise and clear explanation of what Whisparr is, what it does, and how it works. For example, you could say something like: "Whisparr is a software application designed for managing adult movie collections downloaded from Usenet and BitTorrent. It automatically monitors multiple RSS feeds for new movies and can interface with clients and indexers to grab, sort, and rename them. It can also upgrade the quality of existing files when better versions become available."
  • Provide some information on the system requirements for Whisparr, such as the minimum amount of RAM and storage space needed.
  • In the "Installation" section, provide more details on how to install Whisparr, such as whether it requires any dependencies or additional software.
  • In the "URL" section, clarify that users should replace "yourdomain.com" with their actual domain name.
  • In the "Setup" section, provide more detailed instructions on how to set up and configure Whisparr, including how to connect to RSS feeds and clients/indexers, and how to configure the automatic quality upgrade feature. You could also include some screenshots or examples to help illustrate the process.
  • Consider adding a troubleshooting section that addresses common issues users may encounter, and how to resolve them.
  • Lastly, consider including some resources for users who are new to Usenet and BitTorrent, such as beginner's guides or FAQs.

@maximuskowalski maximuskowalski merged commit eecf43e into saltyorg:main Mar 9, 2023
@RaneyDazed RaneyDazed deleted the patch-1 branch March 23, 2023 03:29
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