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

Make lookup of names easier for users #189

Open
Bouni opened this issue Nov 18, 2024 · 2 comments
Open

Make lookup of names easier for users #189

Bouni opened this issue Nov 18, 2024 · 2 comments
Labels
docs Documentation realted enhancement Improving exsisting functionality

Comments

@Bouni
Copy link
Owner

Bouni commented Nov 18, 2024

I think its not very easy for the user to figure out what name / id to use in the HA config.

@Guzz-T made that point in the discussion in #187 , that we should write the code in a way that makes it easy for the user to look the name up.

I propose that we add a GitHub Action that parses the code instead and create a static web page with a search field that we then host on GitHub pages for the users to look the right parameters up.
That is in my eyes the better way to help the user than to write the code in a way that users can look up the needed nmes directly in the code.

@Bouni Bouni added enhancement Improving exsisting functionality docs Documentation realted labels Nov 18, 2024
@gerw
Copy link
Collaborator

gerw commented Nov 18, 2024

I think we should also add some small piece of documentation for each parameter / calculation for which we know the meaning.

@Bouni
Copy link
Owner Author

Bouni commented Dec 11, 2024

@gerw I agree, my key point here is that the user should not have to look up the needed info in the source.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation realted enhancement Improving exsisting functionality
Projects
None yet
Development

No branches or pull requests

2 participants