Local script development

Open
#45 5 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation

Research direction

Start by reading the linked “How to edit scripts with your favorite editor?” article and checking how Violentmonkey sync and local @require development currently work. Done would mean an agreed rewrite or replacement with current screenshots and clear sync instructions, but the preferred article structure still needs maintainer confirmation.

Written by the indexing model from the issue text.

Description

The blog has this article: How to edit scripts with your favorite editor?

However I found it quite confusing - it took me a long time to figure out how to get VM to sync. And quite weird - why do we need to be told you can edit javascript with your favourite editor?

Would there be interest in rewriting and updating it? Or perhaps writing a completely new article, and leaving the old one in place.

I was considering doing that - but I don't want to start if the PR is just going to be rejected after I've done all the work.

To give an outline of how I'd update it:

  • Remove the "Hey you can edit scripts in your favourite editor" part, or at least rephrase it - I fail to see how being told that has any value.
  • Update the screenshots where applicable.
  • Be painfully clear how sync works.
  • Include the @require option for local development.

Would such contribution be welcome?

And what would be the preferred way - write a completely new article, or change/rewrite the old one?

Dominant language
MDX
Stars
55
Forks
35
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from violentmonkey/violentmonkey.github.io

All issues in violentmonkey/violentmonkey.github.io

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.