NotePlan / NotePlan/plugins

Improve visibility of plugin details to 'ordinary' users

Aperta
#273 1 commento 0 reazioni 2 assegnatari Vedi su GitHub

@EduardMe ci sta già lavorando.

Dal 3/5/2022.

documentation enhancement P-10 UI
Lingua principale
JavaScript
Stelle
204
Fork
82
Merge medio
22h 27m
PR unite (30g)
3

Descrizione

We appear to have many users who fail to see the README and CHANGELOG info. Others see GitHub pages and get put off.

We discussed it again at the dev meeting in April and amongst other things noted:

We need to a better way to show new plugin changes to users.
Have a plugin folder with notes which contain the changelogs and documentation. The plugin updater would update the notes
API to open an URL to open documentation and use markdown to open a read-only window
Show the markdown of the readme.md which is already shipped in a read-only editor popup.
How can we add something simple to the sidebar to expose more documentation?

This is particularly important when we move to auto-updating for most plugin changes.

Most of the work is for @EduardMe this time.

But it struck me, @mikeerickson, to ask you to update the way npc does releases to include the CHANGELOG and README in the release. Therefore it will be local and can display quickly and without internet connection. I suggest we continue to host images/videos elsewhere, and accept that they are sometimes unavailable.

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.

Valutazione

Questa issue non è ancora stata valutata.

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.