📚 Documentation: Add inline docs to SDKs
stnguyen90 opened this issue · 9 comments
💭 Description
Inline docs are helpful as they can provide help in the editor when a developer hovers over a method.
Docs can be copied from #671
- android
- cli - not needed
- dart - completed as part of #671
- deno
- dotnet
- appwrite/sdk-for-flutter#152 - completed as part of #671
- go - not ready
- graphql/docs - not needed
- kotlin
- node
- php
- python
- rest/docs - not needed
- ruby
- swift
- #721 (@Im-Madhur-Gupta)
👀 Have you spent some time to check if this issue has been raised before?
- I checked and didn't find similar issue
🏢 Have you read the Code of Conduct?
- I have read the Code of Conduct
I would like to work on this issue for the web SDK part. Would be great if I can be assigned.
cc: @Haimantika
cc: @Haimantika
Hi @Im-Madhur-Gupta have assigned the issue to you! Thank you for showing interest in contributing to Appwrite! Happy Hacktoberfest 🎃
Notes:
- Please update us with your progress every 3 days, so that we know that you are working on it.
- Join us on Discord - https://appwrite.io/discord to chat about Hacktoberfest and Appwrite!
Hey @Haimantika @stnguyen90, I have created a PR for adding the inline doc comments for web SDK template. Please assign someone for the review. Thanks.
Can I work on the node part?
I am happy to work on the Python part! 👍
@xkrishguptaa, are you still interested on working on the node docs?
Hey @stnguyen90! Yes, I'm still interested, Could you please let me know how to get started?
Hello @stnguyen90 , I would like to work on Node SDK, thanks!