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

61–70 of 82 posts

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

#61

Post by gdillon »

emilsedgh wrote: post #60

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.

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 support@readme.io a note if you'd like to get KDE started.

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

#62

Post by anonfunction »

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…

How many people do you have working on the product? It's beautiful and I love how fast it's progressing.

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

#63

Post by gkoberger »

anonfunction wrote: post #62
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…

How many people do you have working on the product? It's beautiful and I love how fast it's progressing.

I'm the developer/designer, and gdillon is doing everything non-technical!

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

#65

Post by dkural »

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.

Now that I re-read my comment, what I actually meant to say is - I had enough bravado swearing by young people in college, and it is time to grow up and act professionally - but now I realize the comment can be read to mean that I had enough of non-swearing PC behavior in college, and it's ok to swear as an adult at work. Interestingly; I stay at an equilibrium of points after roughly equal upvotes and downvotes. I wonder if it would've swung -- or ++ if the meaning was universally conveyed correctly by me.

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

#66

Post by hughstephens »

Love it and agree it's beautiful, but as a startup, I disagree with the "it's just 1hr dev a month" in cost. Setting up something from GitHub onto Heroku or similar costs me about 2 hours (if that), ever. And if it can be updated without too much of a pain, it's hardly going to take >1hr of dev work to maintain the project (update the docs perhaps...but you'll need to take the time to do that regardless).

I totally also agree with the sentiment that people don't pay what most SaaS apps are worth. We save users 3-6 hours per month and charge $13 for the privilege, but even then people frequently complain about pricing (can't please everyone).

Just my 2c. Love the concept and could see myself using it, but the price point is just too much beyond free, compared to DIYing....but I'm an open source person, so that could just be internal biases.

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

#67

Post by kelseyfrancis »

csuwldcat wrote: post #50
kelseyfrancis wrote: post #39

Earlier quoted context omitted.

Agreed. Would you want to see that your doctor's written stuff like that in your chart (e.g., "Patient's got some really fucking bad gout!")? No? Then maybe it's unprofessional.

I'm pretty sure comparing the addition of 'fucking' as a crass emphasis on the seriousness of someone's medical condition, with saying it excitedly when happy about a product or service you're enjoying, is drawing a flagrantly false equivalence. But heck (fuck?), that's just a reasoned, logical, non-PC take on this - three things that are sadly absent from much of the population these days.

Okay. "Patient's cancer is in fucking remission!", said excitedly and happily is nevertheless possibly indicative of generally unprofessional behavior, which was quite obviously the point. But I guess discussions bereft of pedantry and hubris are sadly absent among the HN population these days.

None of us is personally offended by this language. We simply understand that it has no place in professional communications, because it can only really harm perception vis-a-vis just leaving it out and so probably isn't a smart business move.

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

#69

Post by gkoberger »

uncoder0 wrote: post #68

Will I be able to export my docs? I'm not really willing to put my docs on readme.io without knowing I can export all my work if you all go under. I'm currently an Apiary for Companies subscriber and value that feature but, prefer your design.

Yup! There's an Export Docs button on the settings page.

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

#70

Post by prottmann »

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!

Creator of apiDoc here.... really nice that you use apiDoc :-)

I really like your nice and clean template.

A similar project was in my mind since i create apiDoc, but due the lack of time i am happy now that you create such a project.

Will link to your site soon, so that apiDoc users can see your good alternative for creating and hosting a documentation.

Post reply on HN