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

Dedicated Docs page outdated #202

Open
SimonFischer04 opened this issue Mar 17, 2024 · 2 comments
Open

Dedicated Docs page outdated #202

SimonFischer04 opened this issue Mar 17, 2024 · 2 comments
Assignees
Labels
bug Something isn't working

Comments

@SimonFischer04
Copy link
Contributor

The docs here https://drozmotix.github.io/languages/en/Adapter/ESPHome/ are pretty outdated with the recent changes.

How should we proceed here? Of course, we could "simply update it", but as a lot of the info is already in the README, wouldn't that be kind of duplicated and annoying to update 2 sources every time something changes?

@SimonFischer04 SimonFischer04 added the bug Something isn't working label Mar 17, 2024
@DutchmanNL
Copy link
Contributor

DutchmanNL commented May 16, 2024

The docs here https://drozmotix.github.io/languages/en/Adapter/ESPHome/ are pretty outdated with the recent changes.

How should we proceed here? Of course, we could "simply update it", but as a lot of the info is already in the README, wouldn't that be kind of duplicated and annoying to update 2 sources every time something changes?

honestly... struggling with a decision here .... im a still not 100% convinced if the separate docu page has an added value (as it has much more options than the GitHub readme, like language/navigation etc) or to keep all on git....

info should only be on one space, that's a fact and not duplicated or different. Question is, which source/layout etc is the best

my purpose of the docs page was to also have it in different languages and get more support from the communicate maintaining it.
But, honestly, until this moment I did receive 4 pull request on the dock page (in global so not for this adapter specific but all information there sind that source exists) so my intention did not work out as planned :/

@SimonFischer04
Copy link
Contributor Author

honestly... struggling with a decision here .... im a still not 100% convinced if the separate docu page has an added value (as it has much more options than the GitHub readme, like language/navigation etc) or to keep all on git....

Yeah. Same struggle here - not sure whats the best way either, that was why I created the issue. Dedicated docs page has more features, but Readme is whats shown in the adapter info also...

info should only be on one space, that's a fact and not duplicated or different. Question is, which source/layout etc is the best

I 100% agree

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants