Documentation improvements

How can we improve the product docs at docs.interop.io? Is there anything you wish was clearer, covered in more details or structured differently?

1 Like

I would love to see documentation with actual examples. This will especially help with various extensibility settings for example

1 Like

Hi Anil, thanks for the feedback, there’s definitely room for improvement here!
Do you mean more ode snippets, more use cases or something like a whole tutorial with examples of this type - io.Connect Desktop Documentation - JavaScript Tutorial
Or are you thinking about some code examples in the API reference?

Hi
In general the documentation is very good and covers each setting/api very thoroughly. The Tutorial is also very comprehensive. However I felt there were areas where we needed information and there was not a lot of detail

For example: When we integrated our system with Bloomberg, we used the following page in documentation and it did not provide us with a clear path on how to approach this issue. We wanted information on what to ask Bloomberg, what kind of license should we ask them for, how should we go about building a POC (a simple example would have helped here), etc

https://docs.interop.io/adapters/bloomberg/overview/index.html

Thank you

Anil

2 Likes

That’s super helpful. Yes, some of the Adapters documentation and other addon-s can be extended with details. If there are other pages/sections where you have a question or feedback, please always post it here, so we can improve it.
Thanks!

Ok sure, thank you. Your team has been super helpful when we reach out to them

1 Like