NotePlan / NotePlan/plugins

Help Documentation around Templates

Offen
#86 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
JavaScript
Sterne
204
Forks
82
Ø Merge
22 Std. 27 Min.
Gemergte PRs (30 T.)
3

Beschreibung

Is your feature request related to a problem? Please describe.
Templates are very useful and powerful but not very approachable. To understand how to use them, one has to dig into github and search a few different locations to get full context on how to implement some things.

Describe the solution you'd like
I'd like to see some approachable documentation in the Advanced section of the help site here. Something with a few examples that people who might not be programmers or comfortable sifting through github to figure out how to use them.

Describe alternatives you've considered
Currently, the alternative is to simply go through documentation in github for the particular plugin one would like to implement in a template. As a programmer, this isn't daunting but I can see it being a blocker for others to implement which is a shame as I think templates can be very powerful.

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 Durchsicht der vorhandenen Plugin-Dokumentation auf GitHub und des Abschnitts Advanced auf der Hilfeseite unter https://help.noteplan.co/category/38-tips-tricks. Dokumentiere die Verwendung von Vorlagen mit verständlichen Beispielen für Menschen, die keine Programmierer sind; die Arbeit ist abgeschlossen, wenn Benutzer verstehen können, wie sie gängige Plugin-Funktionen in Vorlagen implementieren, ohne an mehreren Stellen auf GitHub suchen zu müssen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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