Help Documentation around Templates

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

まだ誰も着手していません。

評価

難易度
3/5
見積もり時間
1〜2日
初心者へのやさしさ
35/100
issue の種類
ドキュメント
明瞭さ
おおむね明確
活発さ
停滞
領域
documentation

調査の方向性

まず、GitHub にある既存のプラグインドキュメントと、ヘルプサイトの Advanced セクション（https://help.noteplan.co/category/38-tips-tricks）を確認します。プログラマーではない人にも分かりやすい例を使ってテンプレートの使用方法を文書化します。ユーザーが GitHub の複数の場所を検索しなくても、テンプレートで一般的なプラグイン機能を実装する方法を理解できるようになれば、作業は完了です。

索引モデルが issue の本文から書いたものです。

説明

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.

主要言語
JavaScript
スター
204
フォーク
82
平均マージ
22時間 27分
マージ済み PR（30日）
3

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

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

はじめの一歩

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

NotePlan/plugins のほかの issue

NotePlan/plugins の issue をすべて見る

似ている issue

JavaScript の issue をもっと見る

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

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