golemfactory / golem-js-preview-program

3 stars 18 forks source link

[Submission] Golem JS Preview Program - Task 4 #9

Closed lightify97 closed 1 year ago

lightify97 commented 1 year ago

Golem JS Preview Program Submission by lightify97

Thank you for your Golem JS Preview Program Submission!

Please make sure the feedback form in a Markdown file is filled for each of the tasks you’d like to submit! Also, please make sure you've read the terms and conditions for this competition available here -

Legal Info

In order to receive the award, we need a minimum info about you for legal reasons:

Preferred reward currency

There are two currencies you can receive a reward in - USD and GLM. Since GLM is our cryptocurrency, we provide an additional 10% bonus to all rewards paid in GLMs!.

Choose the preferred currency by checking (with x) one of the boxes below:

Please note that if you already have an accepted assignment from any of the freelance websites (e.g. fiverr.com, freelancer.com, upwork.com), you need to choose a reward in USD.

Repository link

https://github.com/lightify97/golem-js-preview-program/tree/master/tasks/4-text-2-speech-server

The task code is added as a submodule in the task folder. Original Repo: https://github.com/lightify97/golem-task-4

Submitted Tasks

How did you find out about Golem JS Preview Program? Please check (with x) the correct box below:

How was your experience with Golem JS Preview Program so far?

Very good and exciting.

Were the tasks easy to understand and did you enjoy solving them?

The task itself was easy but the documentation for the JS library is not helping at all. I've mentioned about this in detail in the Feedback form.

How was your experience with a new Golem JS API?

Very good. I learnt a lot of new things while working with Golem Network and JS api specifically.

Do you have any general feedback about Golem? Is there something we could improve from your perspective?

Please improve the docs so everyone can build great products using Golem Network.

VanDavv commented 1 year ago

Hi @lightify97, thank you very much for your feedback! I'm going through it and I have one question:

You mention that you went through https://handbook.golem.network/ and you suggest a rewrite. We're actually in the middle of a migration to a new docs system that is hosted here - https://docs.golem.network/creators/javascript/

Is the organization of the new docs better? As I don't know to which extent the feedback applies to the old docs and to which to the new one. Happy to hear any suggestions 🙂

lightify97 commented 1 year ago

Hey @VanDavv. Yeah I just went through the the new docs (https://docs.golem.network/creators/javascript/). These are better than previous ones. I assume this is a work in progress. As far as the general learning goes these docs are much better. But, I'll again emphasis the importance of good API documentation. That's what developers dig when faced with a new challenge or experiencing some issue. Hope the Docs team will take it into account. Again Thanks.