JoomGalleryfriends / JG4-dev

Development repository for JoomGallery v4.x
GNU General Public License v3.0
10 stars 6 forks source link

Developer documentation #148

Open Elfangor93 opened 11 months ago

Elfangor93 commented 11 months ago

As soon as others want to start improving JoomGallery they may need to understand hor JoomGallery works under the hood and how they can appraoch things they need for the imrovement they wanna create. See e.g #143. It is important to provide a developer doumentation such that my knowledge about the code base of JoomGallery is provided.

Where and with wich tool do we wanna do the developer documentation? Any suggestions or propositions?

reilldesign commented 11 months ago

I have no experience with special tools for developer documentation. My manuals and documentations for customer sites I implement with the Joomla Core (com_content). For the individual articles I used tocbot in an override. This could still be supplemented by a code syntax higlighter script and should natively meet most requirements.