Ask HN: awesome web-based documentation? • Hacker News Board

Re: Ask HN: awesome web-based documentation?

#21

Post by baddox » Fri, Nov 19, 2010, 12:17 AM UTC

xiongchiamiov wrote: post #13

I'm rather fond of Django's: http://docs.djangoproject.com/en/1.2/

Similarly, http://djangobook.com/en/2.0/ . I really like the user interface for this one.

Re: Ask HN: awesome web-based documentation?

#22

Post by olalonde » Fri, Nov 19, 2010, 12:17 AM UTC

For reference documentation, I find this one great: http://railsapi.com/doc/rails-v3.0.1/

Re: Ask HN: awesome web-based documentation?

#23

Post by auxbuss » Fri, Nov 19, 2010, 12:18 AM UTC

makmanalp wrote: post #14

http://us3.php.net/strstr -> The php docs have one redeeming quality that I wish all of them had: comments! Whenever there is odd behavior, a gotcha, a pitfall, it's always in the comments. No need to trawl through blogs and mailing lists.

I agree, and have an additional comment:

If the comments become part of the documentation, then you need to ruthlessly edit them to remove incorrect advice, duplication, and redundancy. If you simply leave everything there forever, then the comments become worthless. Integrity of information is everything.

Re: Ask HN: awesome web-based documentation?

#24

Post by gkelly » Fri, Nov 19, 2010, 12:18 AM UTC

http://readthedocs.org/

Cool idea for Sphinx-based docs.

Re: Ask HN: awesome web-based documentation?

#25

Post by stephenou » Fri, Nov 19, 2010, 12:35 AM UTC

CodeIgniter: http://codeigniter.com/user_guide

The interface is really simplistic which allows me to read the documentation a lot longer than other site (ex. php.net). Also, it's very well-organized and completed, I can go there every time I have a question about the framework and don't need to Google much.

Re: Ask HN: awesome web-based documentation?

#26

Post by d4ft » Fri, Nov 19, 2010, 12:51 AM UTC

Surprised noone has mentioned Heroku. Simple, accessible, and generally easy to navigate. http://docs.heroku.com/

Re: Ask HN: awesome web-based documentation?

#27

Post by cd34 » Fri, Nov 19, 2010, 1:06 AM UTC

SQLAlchemy http://www.sqlalchemy.org/docs/

Mako Templates http://www.makotemplates.org/docs/

Beautifully written, well documented, plenty of examples and use cases... and then a super responsive developer that appears to never sleep and answers questions posted on the mailing list within minutes.

Pyramid (The Pylons/BFG Merger) http://docs.pylonshq.com/

Documentation + 100% test coverage and also a very responsive development team.

Re: Ask HN: awesome web-based documentation?

#28

Post by bmelton » Fri, Nov 19, 2010, 1:22 AM UTC

Tornado: http://tornadoweb.org/

Django: http://djangoproject.com/

NOT Python.

Re: Ask HN: awesome web-based documentation?

#29

Post by j_baker » Fri, Nov 19, 2010, 1:23 AM UTC

cd34 wrote: post #27

SQLAlchemy http://www.sqlalchemy.org/docs/ Mako Templates http://www.makotemplates.org/docs/ Beautifully written, well documented, plenty of examples and use cases... and then a super responsive developer that appears to never sleep and answers questions posted on the mailing list within minutes. Pyramid (The Pylons/BFG Merger) http://docs.pylonshq.com/ Documentation + 100% test coverage and also a very responsive de…

I can vouch for the developer of Mako and SQLAlchemy. Michael Bayer has even added features to SQLAlchemy just to get one of my previous employers to use it.

Re: Ask HN: awesome web-based documentation?

#30

Post by nicksergeant » Fri, Nov 19, 2010, 1:26 AM UTC

stevelosh wrote: post #5

Flask's documentation is my favorite. I sat down and read all of it one night just because it was so beautiful and readable. http://flask.pocoo.org/

Thought I'd get to Flask before Steve, but clearly I was mistaken. Another vote for Flask. Gorgeous.