Documentation Question re: "Building help for your admin plugin"

[brittainmark]

Zen cart 1.5.7 on:
A couple of questions re documentation page Technical - Building help for your admin plugin

Is it preferred to have the help pages included with the add-on or is acceptable to link out to Git Hub and use MD?
If it is preferred to keep help with the add-on. Would it be a good idea to have a standard directory e.g YOURSTORE/help?
I think this would make it easier to find and also if using encapsulated plug in, in a standard place?

Another thought would be to allow MD to be added to the zen-cart documentation. This may be a step to far! One advantage would be consistent style.
one disadvantage would be control.

By the way what does zen-cart use to render the MD pages in the documentation section - is it in zen-cart?

[swguy]

Bear in mind that sometimes what you're reading in the help (and in this case, this article does) pertains to the *next* version of Zen Cart. You are on the cutting edge!

Answers to questions:
- Please bundle help in with contributions if you're building a contribution. The information you are reading is if you're building something for your store or a client store.
- We haven't done anything with help and encapsulated plugins yet.
- Zen Cart uses Hugo to build its documentation. See https://gohugo.io/

[brittainmark]

Thanks that's great. Yes I realise it is at the cutting edge. Just wanted to make sure I did not go off in the wrong direction