Got started using this a few weeks ago and I really like it. Many of the documentation challenges have been artfully thought through. Highly recommend!
Looks great. This is something I've found myself desperately needing recently. I love the community feature in particular.
Here are my thoughts:
1. The pricing is a bit steep for us, even with the Product Hunt discount.
2. Being able to host things on a subdomain is good, but hosting in a subdirectory would be even better for SEO. Of course this is much more difficult from a technical perspective, but it would be a huge selling point for us.
Here's what Moz.com says about this:
"I would still strongly urge folks to keep all content on a single subdomain. We recently were able to test this using a subdomain on Moz itself (when moving our beginner's guide to SEO from guides.moz.com to the current URL http://moz.com/beginners-guide-t...). The results were astounding - rankings rose dramatically across the board for every keyword we tracked to the pages." [1]
3. Being able to integrate our own authentication system would be nice.
[1]: http://moz.com/community/q/moz-s...
@_jacksmith We use Rails+Devise for authentication (https://github.com/plataformatec...). So anything we can plug into that would work well.
A more generalized approach could be for us to send the user's username & email with an HMAC signature in the URL and have them be automatically signed in with that.
Like the idea of this a lot. There are a couple of 'standardized' formats like swagger for documenting API's - does readme support any?
I was wondering if you have any idea why none of the example integrations (even brick.mozilla) have any activity in the support/community section? It seems like a nice idea but I perhaps it's not something that developers want/need...
@tommoor Thanks Tom! We're currently using APIDoc (apidocjs.com), since it felt the most right to me: inline comments, every explicit, matched how ReadMe works. However, the eventual goal is to have convertors for Swagger,etc.
As for community – honestly, probably because all of them just launched within the past week (along with ReadMe). Brick, for example, was hosted as a GitHub page until last week. That's not much time for people to start asking questions. You may still be right, I guess we'll see :)
That being said, the "Suggest Edits" feature has been getting *a lot* of usage. If nothing else, people love the community aspect in that regard.
See you again at the next PH brunch!
@gkoberger cool stuff, I hope the community section does get used for questions as it would add a lot of value to the product!
Seriously considering implementing for our docs. :-)
Replies
Judo
Hackerpreneur Magazine
Anima App
ReadMe
UXCam App Analytics
INK'A
Learnetto
ReadMe
OneSignal
Hustle X
OneSignal
Lyft
Linear
ReadMe
Hustle X
Linear
ReadMe