[mh] News on the docs

Giles Godart-Brown <[email protected]>
Newsgroups gmane.comp.misc.misterhouse.user
Message-ID <[email protected]>
All

Here is an update on what I've been doing on the docs;

I've created a WIP Document landing page ( 
https://github.com/hollie/misterhouse/wiki/Documentation-Landing-Page) 
linked from the Home page, and harvested as many of the installation and 
configuration documents I could find into a new 'Getting Started' section.

I've taken all the 'local docs' and uploaded them to the wiki and 
indexed them on the landing page.

I've taken all the modules in ./lib of the current Master Branch and 
transcribed whatever I could find from Sourceforge and indexed them into 
https://github.com/hollie/misterhouse/wiki/Items-and-methods. Where 
there wasn't anything in Sourceforge I've created a blank template page 
with 'awaiting contributions' in the index.

I've edited 
https://github.com/hollie/misterhouse/wiki/Protocols-and-Interfaces to 
add links to the many how-to guides and the relevant Items and methods

I've added some incoming docs and suggestions from Rick and Jeff.

Its a big set of docs (e.g. about 230 modules in addition to the core) 
and there are many shortcomings, but these are mostly in areas that are 
at probably now redundant.

The core is in pretty good shape, however there are a few areas where I 
think its a bit lacking and I don't have the knowledge to fix, notably a 
current Windows install and how to for Speech Engines.

A few pages have formatting and editorial problems, I guess caused when 
the Wiki was imported and I will continue to fix these as I find them, 
but I don't propose to make any more significant changes before I've 
heard from the community.

Regards

Giles

________________________________________________________
To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.