search

fuel / depot

Fuel PHP Framework - Fuel v1.x dochub application. Get your info here!
52 stars 26 forks source link

Tutorials #6

Closed zoe-edwards closed 12 years ago

zoe-edwards commented 12 years ago

Can we agree on a standard to write tutorials? I’m fan of Markdown, so naturally I’d vote for that.

Are the tutorials something that are going to be contributed via GitHub, or created on the site?

WanWizard commented 12 years ago

We already agreed. :)

Documentation is going to be written in "Fuel flavoured Markdown", which will be standard markdown with some extra options to create links to other pages, and to include data from the API docs (so you don't have to type the method definitions).

We might introduce a markdown repo later, if and when we have figured out how to deal with local merge conflicts. But for now, the site is better since it will be more accessable for people than a repo for which a pull request is needed.

Contribution is going to be via the site. The site will generate HTML versions of the documenation with will be pushed to github for offline use and for inclusion in the distribution zips.

zoe-edwards commented 12 years ago

Sounds great!