search

clevertech / YiiBooster

YiiBooster
BSD 2-Clause "Simplified" License
544 stars 305 forks source link

User-level documentation #692

Open hijarian opened 11 years ago

hijarian commented 11 years ago

Version 3.0.0 (hopefully) will include the user-level documentation right in the YiiBooster sources, so you'll be able to look how to work with each widget without going to documentation website.

It's still in development, but it's decided that the format will be custom XML tailored to be human-readable, and a set of XSLT stylesheets will be present to convert it to standalone HTML pages or probably something else.

Please note that examples obviously require the full Yii-based PHP website set up to be interactive, so for standalone documentation in HTML format an automatically generated screenshots will be used instead.

hijarian commented 11 years ago

To prevent further possible discussion: no, documentation automatically generated from the docblocks in PHP sources IS NOT the end-user documentation and will never be. YiiBooster will have both of this types of documentation. Also, examples are indispensable in case of UI widgets.