gdillon
Joined 15 years ago
Karma
178
Submissions
29
Member since
Jun 28
cofounder, ReadMe.io
now, Algolia
View on Hacker NewsRecent submissions
Comment · 9 years ago
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...
Comment · 9 years ago
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...
Comment · 9 years ago
Yay! It's great to be working with you all at Tubi TV. Love, your Algolia account executive. :D
Comment · 11 years ago
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.
Comment · 11 years ago
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
Comment · 11 years ago
Thanks for the props, Harshil! ReadMe is psyched to be working with you; you've done a great job with our product!
Comment · 11 years ago
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.