News for hackers. Stuff that matters.

gdillon

Re:Riot – Full-text search engine in Go on Monday October 23, 2017 @04:13PM (#15536562)
Thanks for the links, Mark! (Disclaimer, I work for Algolia.)

As Mark mentions on his summary page, the best place for that kind of information is our CTO's "Inside the Engine" series (8 parts).

https://blog.algolia.com/inside-the-algolia-engine-part-1-in...

Yeah, definitely. It's a product category called, somewhat prosaically, "enterprise search." Algolia's appropriate for this in that we allow you to define data structures on a per-content source basis, and can show the most relevant results for each content source. Usually, enterprise search providers provide lots of out of the box connectors — with us, you'd just shove JSON into the proper index using one of the API clients.

Security is super important, but we can provide encryption-at-rest and have a secured API key [1] feature that allows you to segment your user base.

[1] - https://www.algolia.com/doc/guides/security/api-keys/#secure...

Yay! It's great to be working with you all at Tubi TV. Love, your Algolia account executive. :D
Re:Ask HN: What do you use for internal API docs? on Saturday April 11, 2015 @06:22PM (#9361071)
Thanks for the rec! I'm obviously super biased (ReadMe founder, here), but ReadMe was built for this kind of scenario, spot on. apiDoc is good for keeping the endpoint docs up to date, and you can keep it internal with a password or admin-only access. Search should be improving later this month.
Re:An API is only as good as its documentation on Monday March 30, 2015 @02:13PM (#9291406)
Thanks for the tip, Tim! Happy to answer any questions folks have about my product.

Also, plugging: Swagger support in just a few weeks. And we can currently auto generate endpoint reference docs from your source code using a commenting standard similar to javadoc.

We get all sorts of excited by good API documentation. Weird, right? Apparently not, based on this thread. :D

Thanks for the props, Harshil! ReadMe is psyched to be working with you; you've done a great job with our product!
Hey Colin! I'm @gkoberger's cofounder. We don't have a published roadmap, but we're hard at work. First priority is to release a rewritten template that will accommodate larger, more sophisticated documentation projects (another level of subcategorization, multiple documentation sections within one project, better search). Then, we'll start tackling more automatic ways of consuming code and creating documentation. We're ambitious, stay tuned.
Re:Seed (YC W15) Wants to Reinvent Business Banking on Wednesday February 18, 2015 @12:22PM (#9069674)
Hey, I'm one of the ReadMe founders. Stripe was certainly an inspiration for us. I'm so psyched to have SEED building their API using our documentation tool—nice job SEED!
Re:Open Source alternative to readme.io on Tuesday February 10, 2015 @11:54AM (#9028314)
Very cool, Alex!
Re:Ask HN: What's the best way to write an API spec? on Monday January 19, 2015 @03:10PM (#8913774)
Hah, touché. It's 98% done and only requires a little bit of usability polish before going live. You can shoot me a note (support [at] readme.io) with your project subdomain and I can enable it for you. Appreciate it!
Re:Ask HN: What's the best way to write an API spec? on Monday January 19, 2015 @02:13PM (#8913467)
Hey, thanks for the tip. ReadMe.io cofounder here, happy to answer any questions about my service or API specs in general.

ReadMe.io currently focuses more on the "front end" of the API. We can ingest in-line comments made with the apiDoc.js [1] standard, and then use that description to build an API explorer and reference docs automatically. We like apiDoc because of how concise the comments are, and because they are kept very close to the code (no extra files to maintain). It's not as common as some of the other standards mentioned here, but it's — by far — the fastest and most straightforward way to describe an API.

[1] http://apidocjs.com/

Edit: this is how it's implemented within ReadMe.io: http://readme-sync.readme.io/v1.0/docs

Re:Show HN: ReadMe.io – Beautiful Documentation Made Easy on Tuesday October 07, 2014 @06:45PM (#8424419)
Hey, I'm on the ReadMe team: We love open source. We've started working with a few great projects already. Check out the Ghost.org documentation (and reach out to their CTO, Hannah, she's great!) and the Brick by Mozilla docs are linked elsewhere in this thread. There are a few more that have yet to launch. Shoot [email protected] a note if you'd like to get KDE started.