Zen Cart Logo
Forums / Code Collaboration / Documentation Question re: "Building help for your admin plugin"

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

Views: 2,304

Results 1 to 3 of 3
25 Apr 2021, 10:41 AM
#1
brittainmark avatar

brittainmark

Totally Zenned

Join Date:
Apr 2009
Posts:
507
Plugin Contributions:
1

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

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?

26 Apr 2021, 12:24 PM
#2
swguy avatar

swguy

Administrator

Join Date:
Feb 2006
Location:
Tampa Bay, Florida
Posts:
10,682
Plugin Contributions:
56

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

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/
26 Apr 2021, 12:28 PM
#3
brittainmark avatar

brittainmark

Totally Zenned

Join Date:
Apr 2009
Posts:
507
Plugin Contributions:
1

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

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