Re-frame for clojurescript. Worth reading even if you're not using cljs but are involved in front-end development.
Ask HN: What's the best documentation you've ever read?
31–40 of 79 posts
Re: Ask HN: What's the best documentation you've ever read?
#32I really like the Org mode manual (https://orgmode.org/manual/)
Re: Ask HN: What's the best documentation you've ever read?
#33Any discussion on documentation is incomplete without mentioning Django https://docs.djangoproject.com/en/2.0/
Came here to say this.
The thing I love about Django’s documentation is the layering. From beginner tutorial through to high level overviews of the subsystems, through to detailed usage for the subsystems, through to API level docs, through to the source code - all of it is there, and all linked together well. On top of that, it’s all well written, approachable, full of notes and caveats/warnings where necessary (for the level of the documentation too).
I’ve not seen another set of documentation that provides something at each of those layers.
Re: Ask HN: What's the best documentation you've ever read?
#34Go
Really? I thought they were horrible. I gave up on learning the language mainly because of the documentation.
Re: Ask HN: What's the best documentation you've ever read?
#35PostgreSQL's is very concise, clear, to the point, but still very detailed. Has examples! https://www.postgresql.org/docs/10/static/index.html
Re: Ask HN: What's the best documentation you've ever read?
#36Redux is good given how small the library is. Rust stands out as well
I'm underwhelmed by the Rust docs. The tutorial is OK-ish, but the reference docs are weak. If I have a specific question about some detail of the language, the answer is very rarely there. Sometimes the answer is written up in the bug-tracking system or an RFC. They don't seem to have a culture where someone making a behaviour change, or a language-definition decision, is expected to update the reference manual at t…
Please file bugs against the reference when you have these kinds of questions, it really helps.
> they don’t seem to have a culture
We actually do have that as a literal rule [1], but since we’ve started from a place where the reference is incomplete, we can’t block everything on fully filling out every last detail. It’s being actively worked on though!
1: the rule has been slightly relaxed in the last few months for reasons; now a bug must be filed, rather than writing out the literal text. They usually get done fairy shortly after though.
Re: Ask HN: What's the best documentation you've ever read?
#37Stripe has the best API documentation, I have seen.
I used to think this, but from a recent project with them we found them to be lacking some significant details, and generally fairly shallow. We had to contact support for a lot of clarification, and that took a while with the back and forth.
Re: Ask HN: What's the best documentation you've ever read?
#38Re: Ask HN: What's the best documentation you've ever read?
#39Re: Ask HN: What's the best documentation you've ever read?
#40nobody know shoes by _why
I would say it's pretty terrible at providing a reference for a new GUI system in ruby, but it's also the most fun I've had reading docs