Hacker News Reader

Comment by tyre | Hacker News Reader

Using Angular was a huge pleasure for developing a Chrome Packaged App in every way but one.

Documentation.

It isn't sexy to write docs; as a developer you don't get that feeling of 'shipping code', but it is one of the most important parts of an open source library.

Knowing that your question is always a google away (not a 'I hope someone asked this on StackOverflow' away) is important and I hope they improve in this arena.

View on HN

I concur on the documentation. I spend as much time reading the code to understand the documentation as I do reading documentation to understand code. That seems perverse to me.

My favorite Angular doc page: http://docs.angularjs.org/api/ng.directive:ngModel

Funny that your link was light-gray in color when I loaded these comments (meaning that I, too, once went to that page looking for documentation).

This is mine: http://docs.angularjs.org/guide/dev_guide.unit-testing

It's not the best but I've actually not had too much trouble with the docs. I found the trick is to read the guides first, once you understand the principles that Angular.JS works on the terse reference docs are much more approachable.

A little linking would go a long way though. For example that ngModel page really needs to link to NgModelController!

am I the only one that has never had an issue with angular's docs? :P

You might well be.

Likely. I don't think the "docs" of the core framework are so bad is that there's nothing that really explains "The Why" well. I have a hard time with understanding unless I know The Why, and it's mostly an exercise in rote learning until then, and I think rote learning for something complex like AngularJS is a bad thing

Luckily, I've found the source code to be very readable and easy to understand, which isn't something I can say about a lot of JavaScript libraries.

Reply on news.ycombinator.com