violentmonkey / violentmonkey/violentmonkey.github.io

[Feature] Add docs for @updateURL

Open
#66 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
MDX
Stars
55
Forks
35
PR merge metrics
No merged PRs in 30d

Description

Motivation
Developers need proper docs in order to use all features supported by violentmonkey.
Seems like there is no info in the https://violentmonkey.github.io/api/metadata-block/ about @updateURL

Proposed Solution

  1. Explain if @updateURL is supported or not. An can be used for *.meta.js files only.
  2. Give example of usage at public docs.

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.

Research direction

Start with the public API metadata-block documentation page linked in the issue and inspect its source in the repository. Confirm whether @updateURL is supported and whether it applies only to *.meta.js files, then document the result with a usage example. Done means the page explains the behavior and shows valid usage.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.