You are viewing limited content. For full access, please sign in.

Question

Question

Any plans to modernize the SDK documentation?

SDK
asked on February 8, 2018

The SDK documents (at least as of version 9 - haven't checked 10) are distributed as .chm files, which are very clunky.

Are there any plans to modernize them? Most APIs we use have a web-based format (example 1, example 2) which makes them very pleasant to use, and it would be nice to have the Laserfiche SDK formatted and distributed similarly.

Other things that would be nice:

  • Guides and tutorials for commonly used SDK functionality
  • Examples
1 0

Replies

replied on February 9, 2018

We don't have immediate plans to open the API documentation.

0 0
replied on February 9, 2018

Sorry, I think you misunderstood. I'm not asking about opening it to everyone. I'm asking about changing its format and content to make it more friendly and useful.

0 0
replied on February 9, 2018

Your examples are open APIs, though. We'd have to secure it separately from the rest of the documentation and support site items.

0 0
replied on February 9, 2018 Show version history

Well, I posted them as examples of documentation format (HTML, rather than .chm), layout/organization and content. The reason I used Stripe and Braintree as examples is because they are open and thus can be linked here, not because they are representative of what I am looking for in terms of openness. In other words, I don't expect the LF SDK docs to be openly accessible for everyone.

It would be great, for example, if the SDK docs were also html files that opened in the browser, and they had a modern layout (maybe with Bootstrap or something), and each function/method had clear examples and discussed various use cases and common gotchas, and explained various responses you can get from the server and what that response means.

For example, when I send a POST request to https://stripe.com/docs/api#create_customer I know exactly how the request should be structured and what type of response to expect. I also know what types of scenarios might lead to errors. With .chm files this information is very difficult to glean if one is not already familiar with the SDK. They are also lacking in detail. For example, methods tell you what the parameters are and what the return type is, but its very very barebones (probably because most of it was auto-generated from the code comments).

0 0
You are not allowed to follow up in this post.

Sign in to reply to this post.