Adding the documentation to the git repository...

[flynx]

I think it might be logical to add the demos from the site the the repo, something like a doc/ folder is a really good tradition, plus, having everything needed in one place is generally a better idea than keeping the code in git only and the docs and examples on the site only.

would save lots of time for the user.

[mattbryson]

Yeah, the reason it is separate, is that the docs (and another repo of touchswipe) are hosted on our company Codebase git repo, and are part of a top level repo that contains the skinker labs site.

I can move them over though, but currently they are all php, with includes etc, so the user will not be able to run them as local files, they will have to have a local php server running.

m

[flynx]

Not too elegant...

We had a similar problem in one of the projects I worked on several years
ago, the simplest solution in that case turned out to have the docs as
plain HTML (we used rst, but it does not make any difference here) which
was also included in the main site page template (TAL/METAL), so we had
both a plain and simple set of docs and an up to date site with full
navigation...

This could vary in complexity depending on the template architecture you
are using (really trivial with TAL), but having the benefit of keeping all
the docs in the same repo as the associated lib, and at the same time,
automatically updating the site via an RCS (we used svn at first, then
moved to git) is indeed worth the effort.

On Mon, Jan 14, 2013 at 3:27 PM, Matt Bryson notifications@github.comwrote:

Yeah, the reason it is separate, is that the docs (and another repo of
touchswipe) are hosted on our company Codebase git repo, and are part of a
top level repo that contains the skinker labs site.

I can move them over though, but currently they are all php, with includes
etc, so the user will not be able to run them as local files, they will
have to have a local php server running.

m

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/53#issuecomment-12214681.

Alex.

[mattbryson]

Right, Ive split the notion of Demos and Documentation, and created both as local running files.

Docs are auto generated from source, Demos are real life walk throughs of how to use the plugin.

All are now in the repo (in a branch at moment pending plugin testing) and ill add the demos and docs to the site once I push the changes into master.

m