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

Arduino IoT Cloud Docs #380

Merged
merged 5 commits into from
Jan 29, 2024
Merged

Arduino IoT Cloud Docs #380

merged 5 commits into from
Jan 29, 2024

Conversation

karlsoderby
Copy link
Contributor

Markdown style documentation for this library (following our traditional approach).
Docs will be rendered at https://www.arduino.cc/reference/en/libraries/arduinoiotcloud/

docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
docs/api.md Show resolved Hide resolved
docs/api.md Outdated Show resolved Hide resolved
@pennam
Copy link
Collaborator

pennam commented Sep 27, 2023

Thanks @karlsoderby i left some comments for you.

@pennam
Copy link
Collaborator

pennam commented Sep 27, 2023

Also, some of the boards listed here: https://www.arduino.cc/reference/en/libraries/arduinoiotcloud/ are not compatible with ArduinoIoTCloud and shloud be removed.

removed a number of methods that are not going to be public soon, and general revised some of the other methods
@karlsoderby
Copy link
Contributor Author

@pennam thanks for the review, I've addressed the changes just now.

Regarding

Also, some of the boards listed here: https://www.arduino.cc/reference/en/libraries/arduinoiotcloud/ are not compatible with ArduinoIoTCloud and shloud be removed.

Unfortunately they are added based on the architectures field inside of the library.properties file. Any board that is part of our listed architectures are (incorrectly) listed. That's why boards like MKR Zero and Nano BLE is listed.

@karlsoderby karlsoderby requested a review from pennam September 27, 2023 12:59
@pennam pennam merged commit 60528b9 into master Jan 29, 2024
@pennam pennam deleted the karlsoderby/library-api-docs branch May 23, 2024 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants