appwrite / sdk-generator

Generating SDKs for multiple programming languages and platforms ⚙️
https://appwrite.io
MIT License
273 stars 167 forks source link

📚 Documentation: Add inline docs to SDKs #679

Open stnguyen90 opened 1 year ago

stnguyen90 commented 1 year ago

💭 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 https://github.com/appwrite/sdk-generator/pull/671

👀 Have you spent some time to check if this issue has been raised before?

🏢 Have you read the Code of Conduct?

Im-Madhur-Gupta commented 11 months ago

I would like to work on this issue for the web SDK part. Would be great if I can be assigned.

Im-Madhur-Gupta commented 11 months ago

cc: @Haimantika

Haimantika commented 11 months ago

cc: @Haimantika

Hi @Im-Madhur-Gupta have assigned the issue to you! Thank you for showing interest in contributing to Appwrite! Happy Hacktoberfest 🎃

Notes:

  1. Please update us with your progress every 3 days, so that we know that you are working on it.
  2. Join us on Discord - https://appwrite.io/discord to chat about Hacktoberfest and Appwrite!
Im-Madhur-Gupta commented 11 months ago

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.

kkrishguptaa commented 11 months ago

Can I work on the node part?

RyanBaig commented 8 months ago

I am happy to work on the Python part! :+1:

stnguyen90 commented 8 months ago

@xkrishguptaa, are you still interested on working on the node docs?

kkrishguptaa commented 7 months ago

Hey @stnguyen90! Yes, I'm still interested, Could you please let me know how to get started?

Sachin-chaurasiya commented 7 months ago

Hello @stnguyen90 , I would like to work on Node SDK, thanks!