Hacker News new | past | comments | ask | show | jobs | submit login
A new Erlang docs repository (erldocs.com)
123 points by gruseom on Aug 20, 2009 | hide | past | favorite | 10 comments



heh, author here, I was going to wait a while to submit this, its a little bit messy right now and theres quite a few things that need worked on, but I wanted to get it up sooner rather than later.

Ive got a lot of ideas for what to do with this, but any suggestions / feedback / examples I would be happy to hear.

some goals

  * Fix bugs, few problems with the html being rendered etc
  * Clean up layout, its rather ugly right now
  * Add other documentation types (user guides etc), and link to other 
    good sites http://learnyousomeerlang.com/ etc
  * Make googleable very important
  * User comments, ala php docs 
  * Make it easy to include documentation for 3rd party libraries


Would making it googleable also result in making it viewable as static pages? Under konqueror (3.x), I just get a javadoc looking thing with "Loading..." on the left pane and "welcome to erldocs.com" on the right. I would never ask anybody to write js to support an ancient and unpopular browser, but a static view of the site would be cool.


yeh, I just need to build a static index page, apart from that searchable index the rest of the site is static, as one of the main things I wanted is that the documentation should work offline (which it does including the searchable index)


Ok, cool. It does work under konqueror 4.x, in case you were curious :) Also, should the modules in the list be ordered? They appear not to be, or at least they don't seem to be in any order I can determine.


I would love to see a comments/discussion section for each page. This would be a great way to leave tips/issues you found with the docs. (and could be used to improve the docs)


certainly, thats pretty high on the list of things I want for the site


Front page full of Erlang... did HN make it to a major publication again?


that or 4chan got bored this afternoon?



It would be much better if there were actually a discussion for each posted item.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: