macgapproject / documentation-app Goto Github PK

I originally planned to have a GIT binary embedded into the app, which MG would use to pull in the latest documentation from the GitHub documentation repo. This would nicely illustrate how MG can control an external binary and would also allow the documentation to be used offline.

I'm not sure the way GitHub structures its pages will work inside an HTML5 offline API kind of situation — I could be wrong though.

The realities of my day job and moving house etc mean that I'm not able to put in as much time to the documentation app as I would like so I'm putting word out to see if anyone has some ideas on how the app could be designed (either leveraging what I've put in place thus far, or ditching it entirely).

Any ideas?

Since this is a public example of a MacGap 2 app, we should try to use best-practices wherever we can.

This immediately raises the question of directory structures. What is best-practice for the structure of code in a MG2 app?

Ideas:

1. clone MG2 repo into this one, and clone the documentation repo as a submodule into the public folder where we will also put any app-specific HTML/CSS/JS

— feels messy
— bad for anyone with write permission to the public MG2 or documentation repos as app code could accidentally get pushed into them

2. both the MG2 repo and the documentation repo cloned as submodules into this app repo

• what does the folder structure look like for this?
• where does the app code go (i.e. the public folder) — do we put it beside the MG2 repo and symlink? Change the path MG2 looks for /public?

@rawcreative, @perifer — interested in your opinions here.