Documentation Structure Entmoot about adventure-unconf HOT 3 CLOSED

👍

from adventure-unconf.

👍

I'm really interested in improving contributor docs. The CONTRIBUTING.md and COLLABORATOR_GUIDE.md we currently have do a great job of covering the process, but don't really get into how the actual code works.

Some aspects of the code already have documentation in one form or another somewhere but people may not be aware of them. I'll compile a list of a few things here, but we should work toward integrating these somehow into the contributor introduction/reference docs.

• v8
  • generated API docs for various versions
    • It might be good to have somewhere with generated docs matched to node/io.js versions they are relevant to.
  • more generated API docs
  • performance notes
  • IRHydra2
    • Should probably explain what IR is too...
• libuv
  • docs
  • book
  • rough type docs
• http_parser
  • readme
• openssl
  • ???
• zlib
  • ???
• tracing
  • lttng
  • dtrace ???
  • ETW ???
• quick explanation of test suite directory structure ???
• code style ???
  • We have linting, but it'd be good to understand style before you start writing stuff
• release process

from adventure-unconf.

I think even the API docs could use a little love. For example, if you look up the http.createServer method, you get told what event triggers the callback, but there's no link to that event, and the average user is going to have to command-F to find what that means, before they get to the IncomingMessage and responseObject definitions.

from adventure-unconf.