search

hellosign / hellosign-ruby-sdk

A Ruby SDK for HelloSign's API
MIT License
52 stars 61 forks source link

Where can I find a copy of the ruby-specific documentation online? #3

Closed AlexeyMK closed 10 years ago

AlexeyMK commented 10 years ago

I've scoured through the https://www.hellosign.com/api/reference website, but can't seem to find the ruby-specific documentation. It's clearly available (given the formatted comments) but I can't seem to see an easy way to view it without generating it myself.

asolberg commented 10 years ago

Our Ruby specific documentation basically takes 3 forms 1) The Readme file in this repo, 2) The comment blocks in the codebase of this repo and 3) The ruby SDK examples on our website https://www.hellosign.com/api/reference. Those default to 'curl' but if you toggle one of them over to Ruby then the others will toggle as well.

AlexeyMK commented 10 years ago

Yeah - I just wish (and would strongly benefit from) having the comment blocks extracted into their own web page (IE, hellosign.com/api/ruby-sdk/)

Also, (2) is really not discoverable from the README - you have to manually realize to go to lib/hello_sign/api/signature_request.rb ( https://github.com/HelloFax/hellosign-ruby-sdk/blob/v3/lib/hello_sign/api/signature_request.rb) to get to the 'good stuff'. At the least, a link to the relevant files in the README would be nice.

Alexey

On Tue, May 20, 2014 at 12:27 PM, Arian Solberg notifications@github.comwrote:

Our Ruby specific documentation basically takes 3 forms 1) The Readme file in this repo, 2) The comment blocks in the codebase of this repo and 3) The ruby SDK examples on our website https://www.hellosign.com/api/reference. Those default to 'curl' but if you toggle one of them over to Ruby then the others will toggle as well.

— Reply to this email directly or view it on GitHubhttps://github.com/HelloFax/hellosign-ruby-sdk/issues/3#issuecomment-43671860 .

asolberg commented 10 years ago

We had considered separate SDK doc pages but realized much of the content would be duplicated in the comment blocks and our website (the examples there and the examples in the comment blocks are usually very similar if not identical). So in an effort to reduce maintenance we opted not to. But we may revisit this question in the future so thanks the feedback.