violentmonkey / violentmonkey/violentmonkey.github.io

[Feature] Add docs for @updateURL

Offen
#66 0 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

enhancement
Vorherrschende Sprache
MDX
Sterne
55
Forks
35
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

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.

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne mit der im Issue verlinkten Dokumentationsseite zu den Metadatenblöcken der öffentlichen API und prüfe ihren Quelltext im Repository. Bestätige, ob @updateURL unterstützt wird und ob es nur für *.meta.js-Dateien gilt, und dokumentiere das Ergebnis mit einem Anwendungsbeispiel. Als erledigt gilt die Aufgabe, wenn die Seite das Verhalten erklärt und eine gültige Verwendung zeigt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.