📚 Documentation: library code does not contain clear and or concise documentation

[folaoluwafemi]

💭 Description

Basically the docs from the appwrite.io/docs page are clear, but I expect more finer grained docs from the flutter/dart sdk code to make it much more easier to understand what to do, let me paint a scenario.

• I create a project
• I import appwrite lib in my main.dart file.
• while initializing the Client class [from appwrite lib] I see a param selfSigned and ask myself what it means
  • I attempt a shortcut (ctrl + j on AS or Intellij) to show info from the added documentation, and nothing that can help my situation comes up
  • Confused, I click to go to the declaration to see if there's any helpful info, but alas!!!, there was none.
  • At the last, I had to resolve to opening my browser to get info from the official docs.

My point? it would have been incredibly helpful to have the docs from the appwrite lib, even if it's just the public facing part of the lib.

Thank you.

👀 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

[lohanidamodar]

@folaoluwafemi Thank you for your suggestion. We will work on it.

[stnguyen90]

Whoever works on this can refer to the SDK for web or node to see what the comment docs should be.

[iswarmondal]

Hey, @stnguyen90 @lohanidamodar I'm new to Appwrite community. I just saw this issue and can contribute to clarifying the docs. May I give it a go?

[gewenyu99]

Hey, @stnguyen90 @lohanidamodar I'm new to Appwrite community. I just saw this issue and can contribute to clarifying the docs. May I give it a go?

This isn't really a docs issue, this is a SDK generator issue I think, right @stnguyen90?

But this does sound like a good idea, I believe we brought this up during Hacktoberfest last year?

[iswarmondal]

So what can we do to solve this? I really don't know what you are talking about @gewenyu99

[gewenyu99]

So what can we do to solve this? I really don't know what you are talking about @gewenyu99

We would have to make changes to the SDK Generator.

[stnguyen90]

@iswarmondal, for example, files like these:

• id.dart
• query.dart
• client_io.dart

would need to be updated.

[iswarmondal]

@stnguyen90 thanks mate, 🙌🏼
I'm trying to implement some changes, will create a PR after that

[stnguyen90]

@iswarmondal, actually, we need to update this ASAP, so I think we're going to work on it internally.

[iswarmondal]

@stnguyen90 no problem, I'm happy to interact with you guys

[lohanidamodar]

@folaoluwafemi With new version 9.0.1 this issue should be resolved. We have tried to cover all public functions. Feel free to reopen the issue if you think there's still things missing.