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

Creating the documentation with the essential knowledge (or links) #2261

Open
9 tasks
raffaeler opened this issue Jan 4, 2024 · 0 comments
Open
9 tasks
Labels
documentation Documentation bug or enhancement, does not impact product or test code Priority:1 Work that is critical for the release, but we could probably ship without up-for-grabs Good issue for external contributors to iot

Comments

@raffaeler
Copy link
Contributor

raffaeler commented Jan 4, 2024

In the triage we observed questions on topics that can be considered essential knowledge to know when interfacing devices and sensors with our library.
We all agreed that it would be important creating one or more documents providing the «essentials» concepts useful for every user. This documentation is meant to collect only the topics that are not related to specific bindings.
These are the topics I suggest to include:

Please feel free to add other topics or suggest removing one or more of the above list.

@raffaeler raffaeler added api-suggestion Early API idea and discussion, it is NOT ready for implementation documentation Documentation bug or enhancement, does not impact product or test code Priority:1 Work that is critical for the release, but we could probably ship without labels Jan 4, 2024
@ghost ghost added the untriaged label Jan 4, 2024
@Ellerbach Ellerbach removed api-suggestion Early API idea and discussion, it is NOT ready for implementation untriaged labels Jan 18, 2024
@krwq krwq added the up-for-grabs Good issue for external contributors to iot label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation bug or enhancement, does not impact product or test code Priority:1 Work that is critical for the release, but we could probably ship without up-for-grabs Good issue for external contributors to iot
Projects
None yet
Development

No branches or pull requests

3 participants