Show HN: ReadMe.io – Beautiful Documentation Made Easy
1–10 of 82 posts
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#2Hey all, founder here! I've worked at a bunch of startups, and inevitably we'd have to make a dev.startup.com and I'd wonder why we were re-inventing the wheel each time. Every startup needs this, they all have the same basic features, yet every startup has to do it themselves.
Ergo, ReadMe! I wanted to do more than just documentation; it's a full developer hub for your community. The goal is to make it so any startup can have beautiful, interactive, collaborative, Stripe-quality docs without wasting valuable time.
HN has been a huge help while building it – I even picked the name after finding the domain for sale on HN :)
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#3Love the attention to details, like the focus event on the password field: https://dash.readme.io/login
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#4Really well done product. Using it for my site now.
What are the future plans for making this into a developer hub?
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#5Looks awesome.
I am currently using Swagger to document a REST API.
can I import from the popular Swagger format ( YML) to your platform ?
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#6Looks awesome. I am currently using Swagger to document a REST API. can I import from the popular Swagger format ( YML) to your platform ?
Swagger is on the short-term roadmap! In the slightly shorter future (AKA it's working now, although we disabled it for new signups due to overload), we support apidocjs.com
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#7Hey all, founder here! I've worked at a bunch of startups, and inevitably we'd have to make a dev.startup.com and I'd wonder why we were re-inventing the wheel each time. Every startup needs this, they all have the same basic features, yet every startup has to do it themselves. Ergo, ReadMe! I wanted to do more than just documentation; it's a full developer hub for your community. The goal is to make it so any startu…
Looks great. Wish there was a plan for opensource projects, which allowed me to use customized landing page etc.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#8The most important feature for documentation is /a really good/ search. I can't see anything about searching on the site? Can you clarify?
IMO everybody should use https://readthedocs.org/ for documentation since all the docs will be put into elasticsearch (backed by Rackspace FYI) and the results when searching are of really good quality.
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#9This seems highly dependent on Javascript for displaying its (actually static) content. As someone who likes his notebook fan to stay calm and not have websites shove obnoxious things into her face and thus browses with JS off by default, please do not require Javascript to read your documentation. JS is nice for animations or truly dynamic content, but why require it for static things like this?
Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy
#10Really well done product. Using it for my site now. What are the future plans for making this into a developer hub?
Thanks Frank!
We've already built out a bunch of community features to make it more than "just docs", but we have a lot of things we're really excited about.
We want to do things like have an "application dashboard" (where users can manage API keys), some basic (optional!) API management, onboarding "wizard" and more – the whole developer experience should be cohesive.