Re: wiki structuring

Paul M Jones wrote:

Lukas Smith wrote:

One of the points point of the wiki is that it is more free-form than the highly-structured DocBook; whatever happens on the wiki may or may not be translated into the formal DocBook documentation. I think of the wiki not as the pre-DocBook version, but as its own parallel thing. If we can evenutally use it as a source for DocBook, great, but I believe its best purpose will be found by the end-users, not by PEAR Group or PEAR QA top-down dictate.

I disagree. I think its all cool for people to write examples in their chosen format. But for API documentation a standard is a requirement. Even if it will never be exported to docbook.

Agree that API docs should adhere to a standard. Lucky for us, that standard is already defined, in place, and operational: API docs are automatically generated by PhpDocumentor for all packages. I see the wiki more as example, tutorial, explanation, narrative, prose ... not as an API documentation source.

Ok .. well then we leave API docs out of there. However I think API docs are still somewhat limited by phpdoc, but maybe I just dont know all the tags. Look at the DB API docs for example and compare them to the generated ones. then we just need to define a simple way for people to link to the current version of a method inside the API docs. and then we all can call it a layout guidelines for examples for those who needs guidance and free for all for the rest. regards, Lukas