NotePlan / NotePlan/plugins

Help Documentation around Templates

Open
#86 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
204
Forks
82
Avg merge
22h 27m
Merged PRs (30d)
3

Description

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.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing plugin documentation in GitHub and the Advanced section of the help site at https://help.noteplan.co/category/38-tips-tricks. Document template usage with approachable examples for people who are not programmers; the work is done when users can understand how to implement common plugin features in templates without searching across multiple GitHub locations.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.