Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Developer documentation #148

Open
Elfangor93 opened this issue Sep 20, 2023 · 1 comment
Open

Developer documentation #148

Elfangor93 opened this issue Sep 20, 2023 · 1 comment
Labels
needs discussion This issue or pull request needs further discusion

Comments

@Elfangor93
Copy link
Member

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?
@Elfangor93 Elfangor93 added the needs discussion This issue or pull request needs further discusion label Sep 20, 2023
@reilldesign
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
needs discussion This issue or pull request needs further discusion
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@Elfangor93 @reilldesign