sdk-generator icon indicating copy to clipboard operation
sdk-generator copied to clipboard

📚 Documentation: Add inline docs to SDKs

Open stnguyen90 opened this issue 2 years ago • 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 https://github.com/appwrite/sdk-generator/pull/671

  • [ ] android
  • [x] cli - not needed
  • [x] dart - completed as part of https://github.com/appwrite/sdk-generator/pull/671
  • [ ] deno
  • [ ] dotnet
  • [x] https://github.com/appwrite/sdk-for-flutter/issues/152 - completed as part of https://github.com/appwrite/sdk-generator/pull/671
  • [x] go - not ready
  • [x] graphql/docs - not needed
  • [ ] kotlin
  • [ ] node
  • [ ] php
  • [ ] python
  • [x] rest/docs - not needed
  • [ ] ruby
  • [ ] swift
  • [ ] https://github.com/appwrite/sdk-generator/pull/721 (@Im-Madhur-Gupta)

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

  • [X] I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

stnguyen90 avatar Jun 22 '23 22:06 stnguyen90

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

Im-Madhur-Gupta avatar Sep 30 '23 05:09 Im-Madhur-Gupta

cc: @Haimantika

Im-Madhur-Gupta avatar Oct 02 '23 03:10 Im-Madhur-Gupta

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!

Haimantika avatar Oct 02 '23 07:10 Haimantika

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.

Im-Madhur-Gupta avatar Oct 03 '23 05:10 Im-Madhur-Gupta

Can I work on the node part?

kkrishguptaa avatar Oct 12 '23 19:10 kkrishguptaa

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

RyanBaig avatar Dec 29 '23 09:12 RyanBaig

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

stnguyen90 avatar Jan 01 '24 16:01 stnguyen90

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

kkrishguptaa avatar Jan 19 '24 15:01 kkrishguptaa

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

Sachin-chaurasiya avatar Jan 23 '24 06:01 Sachin-chaurasiya