#143 Documentation

Collapse AllExpand All

brian Sat 5 May 2007

I've started writing some of the documentation.

Documentation will be sourced as fandoc format under src\doc. I'm going to start off with two pods:

  • docIntro: overview, change logs, faq, why Fan rocks, etc
  • docLang: language syntax, expressions, inheritance, etc

Probably what I've already written in docIntro::Overview should be the key content for the fandev.org home page.

I'm going to write a new module called docCompiler which generates a {home}\doc\{pod} directory for each pod with all the HTML documentation:

  • fandoc documents -> html
  • fan APIs -> html
  • implement the correct URI rewriting rules using .. relative hrefs

Login or Signup to reply.