violentmonkey / violentmonkey/violentmonkey.github.io

[Feature] Add docs for @updateURL

Aperta
#66 0 commenti 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
MDX
Stelle
55
Fork
35
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia dalla pagina della documentazione dei blocchi di metadati dell’API pubblica collegata nell’issue e analizzane il sorgente nel repository. Verifica se @updateURL è supportato e se si applica solo ai file *.meta.js, quindi documenta il risultato con un esempio di utilizzo. Il lavoro è completato quando la pagina spiega il comportamento e mostra un utilizzo valido.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.