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

convert to mkdocs with auto-publish #8

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Conversation

Tieske
Copy link
Contributor

@Tieske Tieske commented Jul 31, 2024

This adds a mkdocs workflow and makes it render a website based on the markdown documentation.

To see what it looks like see https://tieske.github.io/homie5-device-profiles/

The workflow will automatically update the site on each push to main. This is my first try with mkdocs but so far I'm loving the simplicity.

@Tieske Tieske requested review from schaze and Thalhammer July 31, 2024 15:08
@schaze
Copy link
Contributor

schaze commented Aug 5, 2024

@Tieske I am pulling out of this.

My initial goal was to add JSON as a device description to get rid of all the thousands of subscribes and publishes and also officially add json as a data format, then take over my already 90% finished profiles and optimize them a bit.

At this point this all so far from what I already had done for my homecontrol profiles and what I initially intended for homie that I don't think it makes sense for me to be involved any more.

@Tieske
Copy link
Contributor Author

Tieske commented Aug 5, 2024

I also don't like the overall result so far. I do like the strictness of the profiles I wrote, to be completely identical across implementations. But the massive wall of text it became and the number of rules and relations are too complicated.

@Tieske
Copy link
Contributor Author

Tieske commented Aug 5, 2024

@Thalhammer wdyt?

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

Successfully merging this pull request may close these issues.

2 participants