Skip to content
This repository was archived by the owner on Mar 25, 2018. It is now read-only.

add "recommended reading" sections to docs #100

@techjeffharris

Description

@techjeffharris

I would like to discuss the pros/cons of having a list of "recommended reading" items at the beginning of a higher-level reference (such as HTTP or Streams) that presents folks with concepts/APIs with which familiarity is recommended to better understand the current document. HTTP, for example, is a high-level core-module that orchestrates many lower-level core modules:

  • EventEmitter
  • Buffer
  • Streams
  • net.Socket
  • net.Server
  • etc...

So the "Recommended Reading" Section could be:

HTTP

Stability: 2 - Stable

Recommended Reading

API References

Guides

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions