Hacker News Board Hacker News, browsed like a classic message board
Live data from Hacker News

Show HN: ReadMe.io – Beautiful Documentation Made Easy

readme.io

Post reply on HN
Print view View original

51–60 of 82 posts

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#51

Post by simi_ »

gkoberger wrote: post #37
benbristow wrote: post #21

"ReadMe has made our lives infinitely easier. We've had it on our todo list for over a year, and a day after finding ReadMe we had our docs launched. We're super impressed. You guys have built a fucking awesome tool." I don't know, but having swearing on a professional website is probably not the best way to go. Looks like a nice startup though.

We debated about this a lot. Jesse wrote to us via our Olark plugin, so there was a back-and-forth – he didn't just start swearing. He was one of our first customers, and having someone we didn't know love our product was awesome. We liked how enthusiastic and genuine it sounded, and I've personally never liked when people type "f*cking" (we're all adults; that asterisk isn't tricking anyone.). But alas, we've remove…

Could've changed it to "friggin'" for the PC folk who get appalled by casualness. That's what I usually do when I'm unsure of how stiff is the other party.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#52

Post by Pushpak »

gkoberger wrote: post #2

Hey 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…

readme looks awesome.

What made you set the free trial to "till you launch" ? Don't you think some would use it for internal docs for there own reference or am i missing something ?

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#53

Post by gkoberger »

ccleve wrote: post #49

How does this connect to an API? Does it read Swagger? Or is all the setup (paths, parameters, etc) done manually?

Currently, you can do it manually or using http://apidocjs.com. (The latter is disabled for new accounts due to heavy load; will be back this week.)

Swagger (and a few other even cooler options) are on their way!

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#54

Post by amanvir_sangha »

jonahx wrote: post #24

This looks nice but $60/mo seems incredibly pricey when there are also nice, and similar, open source solutions such as http://ricostacruz.com/flatdoc/ What extra value am I paying for?

It saves a lot of developer time, you would just have to write the docs in markdown, not have to worry about the layout, hosting or building another app just to manage your docs. IMO it provides a lot of value for money. You could always just use the free plan and then upgrade later. With markdown files, you wouldn't really get locked into the platform.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#55

Post by gkoberger »

Pushpak wrote: post #52
gkoberger wrote: post #2

Hey 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…

readme looks awesome. What made you set the free trial to "till you launch" ? Don't you think some would use it for internal docs for there own reference or am i missing something ?

Got the suggestion from Danny at StatusPage.io. We really wanted people to be able to try everything out without needing a credit card or feeling pressure.

The "upgrade!" alerts get more and more naggy if the system detects you're cheating and using it for internal use :)

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#56

Post by ccleve »

gkoberger wrote: post #53
ccleve wrote: post #49

How does this connect to an API? Does it read Swagger? Or is all the setup (paths, parameters, etc) done manually?

Currently, you can do it manually or using http://apidocjs.com . (The latter is disabled for new accounts due to heavy load; will be back this week.) Swagger (and a few other even cooler options) are on their way!

Swagger would be great. Make sure that you can regen the docs without losing anything when the Swagger spec changes.

What are the cooler options?

(Also, the Blog link in your main menu on the home page 404s)

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#57

Post by pmichaud »

dkural wrote: post #46
curiously wrote: post #27

Earlier quoted context omitted.

to be fair the people who get appalled by reading the f-word are probably not the target customer. who drops f-word all the time? programmers, entrepreneurs, designers, developers, managers. certainly not established 100 year old corporation, but most certainly the hip, fast moving, horny, 20~30 something olds who eat and breathe technology.

More like insecure, inarticulate brogrammers who are getting burnt out overworking but think it's cool. I don't find swearing to be a conducive way of creating an inclusive, thoughtful work environment. I had enough of this fucking bullshit in college. Time to grow the fuck up.

Genuinely curious if your comment is meant to be ironic?

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#58

Post by phaer »

amanvir_sangha wrote: post #54
jonahx wrote: post #24

This looks nice but $60/mo seems incredibly pricey when there are also nice, and similar, open source solutions such as http://ricostacruz.com/flatdoc/ What extra value am I paying for?

It saves a lot of developer time, you would just have to write the docs in markdown, not have to worry about the layout, hosting or building another app just to manage your docs. IMO it provides a lot of value for money. You could always just use the free plan and then upgrade later. With markdown files, you wouldn't really get locked into the platform.

As far as I see, Readme.io has additional features but everything you've listed is available for free on readthedocs.org, built on Sphinx which is free software.

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#59

Post by dskaletsky »

We've been using Readme.io for our documentation for a while now (http://api.knowtify.io). Love the team, but mostly I love that the non-technical folks (ie - me) can maintain/update our API docs without engineering having to time on it. It's one of the last things engineers want to spend time on (and one of the last things I'd want them to spend time on)...

Re: Show HN: ReadMe.io – Beautiful Documentation Made Easy

#60

Post by emilsedgh »

I suggest you guys to host documentations of some major free software projects. It benefits both you and them. They get nice documentation, you guys get some attention.

Edit: Feel free to contact me if you like the idea and would like to do it for KDE project. I'm a minor contributor and I might be able to ease the process.

Post reply on HN