[mh] MisterHouse Docs

All

I'm back in Covid Lockdown again :-(

So I've started to look at the MisterHouse docs.

Here is what I've done over the last couple of days.

  * I've created a new landing page at
    https://github.com/hollie/misterhouse/wiki/GGB-Start-Here
  * I've harvested, coalesced and pointed to existing pages to link off
    this page, creating new pages where necessary. If there is a naming
    conflict I've prefixed my version GGB-
  * I've created a new structure with the ultimate aim of being able to
    navigate to what you want without relying so heavily on search, and
    making it easier for newbies.
  * I've made a distinction between 'protocols and interfaces' which
    will point to instructions on how to implement each and 'items and
    methods' which is just hoovering up the sourceforge .pm files.
  * I've only done a couple of sourceforge files so far (e.g.
    Generic_Item), there are lots to do I believe.
  * I've added a hints and tips page so we can gather input from the
    community (and maybe roll these into a future release)

I've found a couple of places where I 'ran out of talent', maybe someone 
can help;

  * The Speech engine page
    https://github.com/hollie/misterhouse/wiki/Speech-engines is very
    out of date
  * A couple of windows questions-
      o the Windows install looks very daunting
        (https://github.com/hollie/misterhouse/wiki/WindowsPerl5.12) is
        it really this hard?
      o When you start on windows, where do you set the mh.private.ini
        location? I need this for the installation screen
        (https://github.com/hollie/misterhouse/wiki/Installation)

Next steps

  * Take direction from the community on what I should fix/change
  * Adding the missing item definitions from sourceforge
  * Clean up the protocols and interfaces to link to the existing wiki
    pages and create new placeholders for missing ones.
  * Fix broken links

Looking forward to input from you all

Happy New Year

Giles

p.s. 'then I ran out of talent' is a famous quote from a rally car 
driver after he'd crashed! - G

________________________________________________________
To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users