Re: [mh] Documentation questions

[Giles Godart-B. <ggo...@gm...>]

I've been working on debouncing xPL messages, and would like to contribute.

I'd also like to volunteer to help with docs

Giles


On 29/03/2018 04:39, H Plato wrote:
> That makes good sense. With the uncertainty around sourceforge, would be good to migrate that elsewhere. I thought the git wiki was pretty up to date, but pruning the obsolete information would be useful.
>
> I’ve been working on a few updates for the upcoming release, adding in an updated user docs section would be a nice additional feature.
>
> So far 5.1 has;
> - mysensor updates
> - plcbus updates
> - razberry fixes
> - noaa fixes
> - nanoleaf aurora support for new firmware and rhythm module
> - IA7 v2. I’ve been working to optimize the load time to the collection screen. For me it was about 4 seconds in MH5. in MH5.1 it’s under 2. IA7 v2 has also native trigger support, Tobias’s cool real-time zoneminder notifications and direct control for multiple states, automatic reconnect if the connection to MH is lost, and some basic stuff to support Wayne’s ideas about some user and group management. There are also some bugfixes
>
>> On Mar 28, 2018, at 7:58 PM, Jim Serack <ji...@se...> wrote:
>>
>> Seann,
>>
>> I do think it is important to have a place for current documentation - not only to help new users - but to attract them. Current documentation is a key  indication of a thriving open source offering worth using.
>>
>> I'm no expert on the readthedocs approach and if it is the best approach but having it tied to github and built from the project does sound appealing.
>>
>> I did contribute to former documentation ( .... maybe a decade ago ... !) and I would be willing to contribute to whatever modern update approach the group decides to take.
>>
>> Jim
>>
>> -----Original Message-----
>> From: Seann [mailto:nom...@ts...]
>> Sent: Wednesday, March 28, 2018 2:05 PM
>> To: The main list for the MisterHouse home automation program
>> Subject: [mh] Documentation questions
>>
>> As I am getting back into the heavy rebuild of my Misterhouse system, I have been running through a lot of the documentation on the main Github project, and have noticed a few things as being broken, namely with the Wiki-spaces references, as Wiki-spaces closed down/is closing down as well as the Misterhouse wiki has expired.  I have also noticed a lot of tips and tricks from the mailing lists, but these aren't always easy to find, especially when sourceforge is down for whatever reason.
>>
>> All of this being said I am wondering if we have looked at taking a different route with the default documentation for the main branch (installation guides, etc, in the /docs/ directory) such as using readthedocs.io for the setup/how to items in the docs directory. This would require a bit of work as it use either Markdown or reStructuredText formats, but looking at it, so long as the docs are updated in the project, it can automatically update the readthedocs page, instead of having to manually maintain the website in addition to the included in the project text.  I am also thinking this can be expanded out to configuring specific aspects of Misterhouse (such as Insteon configuration, Google Voice, etc) in a high level/getting started manner.
>>
>> With the Misterhouse GIT Wiki, it could be used to explain specific use cases and 'how I did it' type of details, and maybe set up an advanced how to for commonly used aspects of misterhouse/commonly inquired about aspects.
>>
>> I am thinking of beginning to extract and edit some of the perl comments in the libraries, etc, into topic specific readme's on my local build, and am very willing to assist, or create a branch with my documentation efforts, if the user group thinks my above mentioned statements are a good idea for Misterhouse.
>>
>>
>> Regards,
>> Seann
>>
>>
>> ------------------------------------------------------------------------------
>> Check out the vibrant tech community on one of the world's most engaging tech sites, Slashdot.org! http://sdm.link/slashdot ________________________________________________________
>> To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users
>>
>>
>>
>> ------------------------------------------------------------------------------
>> Check out the vibrant tech community on one of the world's most
>> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
>> ________________________________________________________
>> To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users
>>
>
> ------------------------------------------------------------------------------
> Check out the vibrant tech community on one of the world's most
> engaging tech sites, Slashdot.org! http://sdm.link/slashdot
> ________________________________________________________
> To unsubscribe from this list, go to: https://lists.sourceforge.net/lists/listinfo/misterhouse-users
>