Documentation Location

[Matt Quackenbush]

OK, folks, since we now have an official mailing list, I figured I'd put it to better use than a "First!" thread.  :-)

Currently the documentation consists mostly of demos (http://www.quackfuzed.com/demos/cfUniForm/) and detailed comments/usage examples at the top of each file.  Now that the library is on GitHub (https://github.com/QuackFuzed/cfUniForm), I'd love to get away from the habit of maintaining comments and usage examples in each file.  However, the demos don't really cover the full breadth of flexibility that is built into the library.

So, my question to you awesome folks is: Where would the best place for documentation be, and in what format?

I _think_ that GitHub offers a wiki or something along those lines, but I've not researched enough to be sure.

[Marc Esher]

You can enable the wiki in your repo config in github, and from there
editing pages is pretty simple, though you will need to get used to
the (light) wiki syntax for whichever "language" you use (markdown,
etc).

> --
> You received this message because you are subscribed to the Google Groups
> "cfUniForm-users" group.
> To post to this group, send email to cfunifo...@googlegroups.com.
> To unsubscribe from this group, send email to
> cfuniform-use...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/cfuniform-users?hl=en.
>

[Matt Quackenbush]

MarCdown FTW!  :-)

I am a big fan of Markdown, anyways, so that will work a treat.  Presumably the pages are also editable by the community, since they're calling it a wiki?  (I've not yet checked; plan to do so later today.)

[George Murphy]

I agree with Marc put it in a Wiki. I have been thinking about do some videos for it. It would really help new folks get started.

Thanks,

George Murphy

--
George Murphy
President
DeSign By George, Inc.
http://www.websbygeorge.com
703-867-1934

[Mark Mandel]

Yeah, put it in the Wiki.

Although it is nice to see the running demo code.

If you want to upload flat html files, you can also use GitHub Pages for that. It's pretty neat.

Mark

E: mark....@gmail.com
T: http://www.twitter.com/neurotic
W: www.compoundtheory.com

cf.Objective(ANZ) + Flex - Nov 17, 18 - Melbourne Australia
http://www.cfobjective.com.au