Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Need documentation for Home Assistant #5

Open
dlarrick opened this issue Nov 30, 2019 · 7 comments
Open

Need documentation for Home Assistant #5

dlarrick opened this issue Nov 30, 2019 · 7 comments

Comments

@dlarrick
Copy link
Owner

Since Kumo is implemented as a platform (so we could eventually add sensors), good examples may be https://www.home-assistant.io/integrations/ecobee/ or https://www.home-assistant.io/integrations/dyson/ .

@omriasta
Copy link
Collaborator

I am forking the documentation right now to try and get something started. Never done this before so bare with me. THe fork can be found here https://github.com/omriasta/home-assistant.io

@omriasta
Copy link
Collaborator

OK, I set a baseline. I'm a bit unsure how to properly share the documentation since it requires cloning the repository and running it locally to generate the preview. If you look at the repository I pasted above you can find the file source/_integrations/kumo.markdown which is just a text file that can be edited.
I left some attributes with question marks and I am unsure I got the ones I listed correctly.
The way it looks:
Kumo - Home Assistant

@dlarrick
Copy link
Owner Author

This looks like a good start. Since it's just straight markdown with some HA extensions, one way would be to keep it directly in the hass-kumo repo until it's time to make a PR against HomeAssistant itself. The markdown doesn't render 100% correctly, but the content is all there for review.

I should have a chance to review it more closely over the holidays.

@omriasta
Copy link
Collaborator

You can grab it from my GitHub fork of the documentation. You just need to remember to add the kumo logo to the correct folder as well.

@danielgoepp
Copy link
Collaborator

@dlarrick and @omriasta this documentation request was from quite a while ago, and I'm wondering where this ended up. Things have obviously come quite a way from here. I'm wondering if there are areas specifically that need help, or just any further general updates. What do you guys think?

@dlarrick
Copy link
Owner Author

dlarrick commented Sep 9, 2021

The task is basically to understand & follow the HA guidelines for documentation. I think what's shown in this issue is probably close. I am sure it needs to be updated for the current software, though.

@danielgoepp
Copy link
Collaborator

Cool, thanks. I'll review it in more detail then. I wasn't sure if that was duplicate effort or not yet.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants