NotePlan / NotePlan/plugins

Improve visibility of plugin details to 'ordinary' users

オープン
#273 コメント 1 件 リアクション 0 件 担当者 2 名 GitHub で見る

@EduardMe がすでに取り組んでいます。

2022年5月3日 から。

documentation enhancement P-10 UI
主要言語
JavaScript
スター
204
フォーク
82
平均マージ
22時間 27分
マージ済み PR(30日)
3

説明

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.

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。