violentmonkey / violentmonkey/violentmonkey.github.io

[Feature] Add docs for @updateURL

Ouverte
#66 0 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

enhancement
Langage dominant
MDX
Étoiles
55
Forks
35
Métriques de merge des PR
Aucune PR mergée en 30 j

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.

Guide de contribution

Aucun guide de contribution indexé pour ce dépôt

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

Commencez par la page de documentation des blocs de métadonnées de l’API publique liée dans l’issue et examinez sa source dans le dépôt. Vérifiez si @updateURL est pris en charge et s’il s’applique uniquement aux fichiers *.meta.js, puis documentez le résultat avec un exemple d’utilisation. La tâche est terminée lorsque la page explique le comportement et montre une utilisation valide.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Clairement spécifiée
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.