Lack of Documentation

[flexchar]

No offense but guys you don't have any documentation. List of method signatures on the README file are nearly pointless without actual examples or at least method definitions.

[sitereactor]

Hi @flexchar we do have a fair amount of documentation on our.umbraco.com/documentation/ but I do realize that its not actually linked to from anywhere in this repository. We will get that updated.

You can find API Documentation for all endpoints in both the Content Delivery and Content Management APIs here:
https://our.umbraco.com/documentation/Umbraco-Heartcore/API-Documentation/

But what you are asking for is usage documentation for the client library itself, right?

[flexchar]

I have seen these resources. However I don't find them particularly useful if I am onto using the official client. Which I believe should have at least method definitions for parameters.

Ideally examples on how to use particular method and what data to provide. Now it is merely a list of signatures on your client.

I will shamelessly share (I am not affiliated but happy customer) Sanity Client as an example. Sanity is another powerful headless CMS. https://www.npmjs.com/package/@sanity/client

If you would have docs like that, it would ease the process by a lot. :)

[flexchar]

If you have tests, please publish the code. That would on its own provide quite decent insight 💡

[sitereactor]

Thanks for the feedback!
We have scheduled some initial work around getting better docs in place for this nodejs client library, so we should soon be able to publish some better docs.

I will update this thread when the first iteration is published.

[sitereactor]

@flexchar This has now been addressed by #17 which was just merged. The README file is updated with details. For now you will need to generate the documentation from the repository, but we are working on getting it added to the Umbraco Heartcore documentation on https://our.umbraco.com/documentation/Umbraco-Heartcore/