SDK reference overhaul - Githubissues

GoogleCloudPlatform / iot-device-sdk-embedded-c

Cloud IoT Device SDK for Connectivity to IoT Core.

Other

247 stars 83 forks source link

SDK reference overhaul #81

Closed soyrice closed 4 years ago

soyrice commented 5 years ago

Publish new SDK reference. This update:

Improves the onboarding experience for new users
Reorganizes the reference to make it easier to find key methods and resources
Documents missing topics to make the reference more comprehensive for advanced users (especially those modifying the SDK itself)

sheindel commented 5 years ago

@atigyi lots of good changes in here, would love to get this in. looks like this Travis build failed for the same reason mine did (FreeRTOS download issue) and the iotc_error.h conflict needs resolved (@soyrice are you able to commit a resolution for the file conflict?)

soyrice commented 5 years ago

@atigyi lots of good changes in here, would love to get this in. looks like this Travis build failed for the same reason mine did (FreeRTOS download issue) and the iotc_error.h conflict needs resolved (@soyrice are you able to commit a resolution for the file conflict?)

Done :)

atigyi commented 4 years ago

@soyrice, it seems I've gone through all the .h files. Great job, I especially like the phrases you use and the dense cross-references (links) appeared in the doc. Thank you! 👍 Please go through my notes, make the changes if you agree, or comment if you don't.

After this is done, please regenerate the .html content. If everything goes well, then this can be merged to development. Probably after this I will update the gh-pages branch which serves the docs.

soyrice commented 4 years ago

@soyrice, it seems I've gone through all the .h files. Great job, I especially like the phrases you use and the dense cross-references (links) appeared in the doc. Thank you! 👍 Please go through my notes, make the changes if you agree, or comment if you don't.

After this is done, please regenerate the .html content. If everything goes well, then this can be merged to development. Probably after this I will update the gh-pages branch which serves the docs.

Done.

atigyi commented 4 years ago

We are having great progress, only few more @soyrice! Thanks for your great effort!

Also after all the changes .htmls should be regenerated. Please do this regeneration in separate commit, thx!

👏

atigyi commented 4 years ago

Very precise doc overhaul, thank you @soyrice !! :clap: :100: