gautamkrishnar / motrix-webextension

A browser extension for the Motrix Download Manager
GNU General Public License v3.0
1.21k stars 97 forks source link

Documentation on Blacklist Syntax #109

Closed AyoungDukie closed 1 year ago

AyoungDukie commented 1 year ago

Just wanted to ask if there would be a preferred way to add documentation about using the Blacklist feature. Currently things are a tad open-ended because many similar extensions use differing ways to fill in these rules, and it could be helpful to have something telling users how to properly do so here.

To summarize what I believe I understand after looking into the scripts some:

These were the main ones that I have come across so far, but I'm sure there are others, and having this in writing somewhere seems like a good idea. I'd be happy to make a PR in whatever way is preferred!

Thanks again!

TeusDev commented 1 year ago

bump

gautamkrishnar commented 1 year ago

@AyoungDukie @TeusDev sorry for missing the issue. Feel free to open PR with the settings page here: https://github.com/gautamkrishnar/motrix-webextension/blob/master/app/scripts/config.js you can use https://mui.com/material-ui/ to style it.

AyoungDukie commented 1 year ago

Okay, I think the simplest solution to start is using the helperText property of the TextField; but it would probably be a good idea to also add a documentation page that can be linked to for more formal/full explanations.

Pull request is here https://github.com/gautamkrishnar/motrix-webextension/pull/110

Edit: Resolved as of 22.11.4

AyoungDukie commented 1 year ago

With that merge complete, I have made a follow-up pull request to add a new documentation file for info on the settings https://github.com/gautamkrishnar/motrix-webextension/pull/111

I think once completed, we can close this issue!

Thanks for working through these!

gautamkrishnar commented 1 year ago

@AyoungDukie thanks for contributing ⭐

AyoungDukie commented 1 year ago

Glad to be able to help!