logo       

docs, docs development, and development docs: msg#00181

web.phpgroupware.general

Subject: docs, docs development, and development docs

I was wondering if there could be some discussion (and conlcusion) about how we
could set up a system/procedure to allow easier creation of documentation

My personal preference is for wiki's since they are easy to edit and add to as a
group, a little at a time, but I don't know if that would satifsy all of our
needs.

To start discussion, what about this proposal:
1. we have a public access (read only) wiki at docs.phpgroupware.org that only
authorized personel could edit
2. we have a public access (read and write) wiki as a development playground as
a
subsection of docs.phpgroupware.org

The wiki's should be organized into Users and Developers sections to help
organize
the info but all of it should be public readable.

I understand that some people would like the docs included with the app. Is it
practical to make html pages from the wiki pages automatically? How should
this be
done?

What about inline code docs? I know some developers would like them.


<Prev in Thread] Current Thread [Next in Thread>
Google Custom Search

News | FAQ | advertise