Said it at the end of that topic, we need to look more towards a WIKI example.

Code: Basic functionality + Link Website: Basic functionality + expanded 
information + examples + searchable/link-able by google etc

**Website Documentation Wiki**

[Basic information produced automatically from the code doc generator] 
[Extended information from a wiki]

How to:

  * Doc generator creates for each function a file ( araq already not going to 
be happy _lol_ ) with the basic information. Example: module/function_base.html
  * Doc generator creates also a "master" file. Example module/function
  * Wiki pages are created for each function.



This master file ( module/function ) simply does:

Include function_base.html Include wiki documentation function...

The site uses only the master files for searching, index etc.

**Advantages**

  * Clean source code ( no need for examples etc in the source )
  * Simple to maintain source documentation
  * Website documentation is expandable & maintainable
  * Upgrades in the code documentation can be reflected in the website 
documentation without any danger that it will destroy the layout / interfere 
with the wiki content.


Reply via email to