On 21 Jun 2014, at 19:19, 'Norbert Fuhs' via nodejs <[email protected]> wrote:
> I don't think the node.js GitHub wiki and API reference documention are: > > 1. beginner friendly This is hard -- beginner with what context? I'd love to see documentation made this way, but it's a big job. > 2. easy to read I happen to love the current style, but I could see other styles being MUCH more effective for others -- but this is subjective, so it's not easy to get consensus on in the abstract. > > 3. explain exactly what the modules does and for what it is for What it does ... well, that I think it covers. What it's for, though, ends up leading toward prescriptive documentation, which I don't think is appropriate. People think of new uses all the time, so it's not always great to have a finite list published right there. > > > Is there an up to date list of undocumented methods and properties in the > node.js API reference documentation? No -- they're undocumented because they're not part of the public API. The documentation defines the public API. > Most node.js stuff i learned is from blogs and node.js related books, i think > we need better and more structured documention like the > the docs and tutorials in the Mozilla Developer Network or the Chrome > Developer Tools for node.js. That'd be nice to see, for sure! I'd love to see improvements, too. Not sure I want THOSE, but good resources are awesome (And we can have multiple, for different audiences) Thoughts?
signature.asc
Description: Message signed with OpenPGP using GPGMail
