search

RavenSystem / esp-homekit-devices

Advanced firmware to add native Apple HomeKit and custom configurations, compatible with any SoC based on ESP32, ESP32-S, ESP32-C and ESP8266 series. (Shelly, Sonoff, Electrodragon, Tuya...)
Other
2.75k stars 361 forks source link

Documentation changes #652

Closed WizBangCrash closed 4 years ago

WizBangCrash commented 4 years ago

@RavenSystem I have been updating all my Sonoff's from RavenCore to HAA and it has been quite a learning curve getting to understand the JSON Config. As I have tried to learn more about HAA I have been updating my own copy of the Wiki documentation to capture these things. Recently I got carried away and have completely reformatted / restructured the documentation to help me navigate to the bits I want faster. Would you be interested in merging these changes into your own Wiki? If yes, let me know and we can sort out the details of how to merge.

My wiki can be found here: https://github.com/WizBangCrash/esp-homekit-devices/wiki

It's not complete yet, but is probably 80% there. I plan to add more examples once I understand a little more about the "f0" specific status buttons :-)

You're doing great job BTW. Keep up those improvements and new features coming.

RavenSystem commented 4 years ago

It is amazing!! A great job! Of course, I am interested. Do you want to be collaborator of this wiki repo?

WizBangCrash commented 4 years ago

I'm happy to be a collaborator if you are okay with that. I'll finish off changing everything over to the new format and then I'm happy to merge it into the main repo.

WizBangCrash commented 4 years ago

@RavenSystem What's your preference. Do you want me to merge in my current changes to master and then continue to edit and update this repo's Wiki as I modify it, or would you prefer me to merge my changes into a wiki repo branch for you to review etc. before merging into master?

I've still got a fair bit to do, but I think the facts are correct, so I don't think my updates will mislead people (too badly :-)

RavenSystem commented 4 years ago

Merge to master.

BTW: Are you on Discord chat?

WizBangCrash commented 4 years ago

Okay. Give me a couple more days to clean things up and then I'll merge. I have a couple of images you will probably want to move to your media repo when I do.

No. I don't use Discord.