Results 1 to 3 of 3
  1. #1
    Join Date
    Apr 2009
    Posts
    379
    Plugin Contributions
    2

    Default 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?
    Mark Brittain
    http:\\innerlightcrystals.co.uk\sales\

  2. #2
    Join Date
    Feb 2006
    Location
    Tampa Bay, Florida
    Posts
    8,837
    Plugin Contributions
    118

    Default 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/
    That Software Guy. My Store: Zen Cart Modifications
    Available for hire - See my ad in Services
    Plugin Moderator, Documentation Curator, Chief Cook and Bottle-Washer.
    Do you benefit from Zen Cart? Then please support the project.

  3. #3
    Join Date
    Apr 2009
    Posts
    379
    Plugin Contributions
    2

    Default 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
    Mark Brittain
    http:\\innerlightcrystals.co.uk\sales\

 

 

Similar Threads

  1. v154 Need help building a plugin for the Contact Us page!
    By Feznizzle in forum All Other Contributions/Addons
    Replies: 6
    Last Post: 13 Jun 2015, 05:04 PM
  2. Plugin or Module for "you haven't reached your shipping limit"
    By fctoma in forum Addon Shipping Modules
    Replies: 1
    Last Post: 18 May 2011, 07:15 PM
  3. not your normal "HEADING_TITLE" question?
    By aminrod in forum Templates, Stylesheets, Page Layout
    Replies: 4
    Last Post: 2 Feb 2010, 11:37 PM
  4. For images, does "base" = "small"? And a question about alternates.
    By molywerks in forum Templates, Stylesheets, Page Layout
    Replies: 5
    Last Post: 29 Feb 2008, 02:49 PM
  5. "not shipping to your area" and "no payment options for your area"
    By Dinnages in forum Built-in Shipping and Payment Modules
    Replies: 22
    Last Post: 11 Jul 2007, 01:24 PM

Bookmarks

Posting Permissions

  • You may not post new threads
  • You may not post replies
  • You may not post attachments
  • You may not edit your posts
  •  
disjunctive-egg
Zen-Cart, Internet Selling Services, Klamath Falls, OR