Improve the process of writing userscripts

minbrowser / min

A fast, minimal browser that protects your privacy

https://minbrowser.org/

Apache License 2.0

7.71k stars 684 forks source link

Improve the process of writing userscripts #2362

Closed PalmerAL closed 6 months ago

PalmerAL commented 6 months ago

Enabling userscripts now creates the directory automatically, and I've added a button from the settings page to open it:
Userscripts now reload when edited, so that only the webpage needs to be reloaded rather than restarting the browser.

If anyone has feedback on this, let me know! I'd like for userscripts to be more accessible and easier to set up, so I'd be interested in hearing further ideas to make that happen.

wong-justin commented 6 days ago

I like these changes. I think the only improvements would be in documentation. The "learn more" wiki page is a nice entry-level summary, but it doesn't appear at the top of web search results, and it doesn't document the userscript header thoroughly (@match syntax, @run-at options, etc).

Some suggestions:

change "learn more" to something descriptive like "see userscript documentation"
link to the userscripts wiki page from a central location like the readme or the website
in the userscripts wiki page, document the syntax more thoroughly, or link to a more comprehensive reference like Violentmonkey API docs.

PalmerAL commented 4 days ago

@wong-justin Good points!

I think I'm going to leave this as-is, only because this string is translated into a bunch of languages and it'd have to be re-translated.
Done: a95538bf730c29fb24c517ac3d44b4217f473d56
Unfortunately, I think our syntax isn't totally compliant with Violentmonkey or any other spec; we should probably address that first (always open to contributions on this :) )