Title: add "recommended reading" sections to docs · Issue #100 · nodejs/docs · GitHub
Open Graph Title: add "recommended reading" sections to docs · Issue #100 · nodejs/docs
X Title: add "recommended reading" sections to docs · Issue #100 · nodejs/docs
Description: 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 ...
Open Graph Description: 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 w...
X Description: 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 conce...
Opengraph URL: https://github.com/nodejs/docs/issues/100
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"add \"recommended reading\" sections to docs","articleBody":"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: \n- `EventEmitter`\n- `Buffer`\n- `Streams`\n- `net.Socket`\n- `net.Server`\n- etc...\n\nSo the \"Recommended Reading\" Section could be:\n# HTTP\n\n```\nStability: 2 - Stable\n```\n## Recommended Reading\n### API References\n- [events](https://nodejs.org/api/events.html)\n- [buffer](https://nodejs.org/api/buffer.html)\n- [stream](https://nodejs.org/api/stream.html)\n### Guides\n- [Anatomy of an HTTP Transaction](https://github.com/nodejs/docs/blob/master/src/guides/anatomy-of-an-http-transaction.md)\n","author":{"url":"https://github.com/techjeffharris","@type":"Person","name":"techjeffharris"},"datePublished":"2016-04-18T18:37:19.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/100/docs/issues/100"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:4c4d8a00-2f8b-9722-e3a8-b3aa3c915d17 |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | 9EE6:69662:182B6FB:21658EA:6A4EB3A3 |
| html-safe-nonce | defea11e07d82a82dea283e230db52e47846bd2c690d5dd31a8017c9217fb219 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiI5RUU2OjY5NjYyOjE4MkI2RkI6MjE2NThFQTo2QTRFQjNBMyIsInZpc2l0b3JfaWQiOiIxMjM1MDg1MzMwMjc0NDk3NDQ0IiwicmVnaW9uX2VkZ2UiOiJpYWQiLCJyZWdpb25fcmVuZGVyIjoiaWFkIn0= |
| visitor-hmac | 46eb2ec1a2cec899831ca6b5b1d703d69eada3e92d9131b14a5fed3c6ffc06a4 |
| hovercard-subject-tag | issue:149235128 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/nodejs/docs/100/issue_layout |
| twitter:image | https://opengraph.githubassets.com/3e2a9c75577ef8843d0dfe4a2a2a17e8a61664e097fafbf681cf5670e78591c9/nodejs/docs/issues/100 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/3e2a9c75577ef8843d0dfe4a2a2a17e8a61664e097fafbf681cf5670e78591c9/nodejs/docs/issues/100 |
| og:image:alt | 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 w... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | techjeffharris |
| hostname | github.com |
| expected-hostname | github.com |
| None | 41b6ab3ba6d20a71766ac245b5a4a94c6fc672a9cd4da7d44c1b33ab8bf6a21c |
| turbo-cache-control | no-preview |
| go-import | github.com/nodejs/docs git https://github.com/nodejs/docs.git |
| octolytics-dimension-user_id | 9950313 |
| octolytics-dimension-user_login | nodejs |
| octolytics-dimension-repository_id | 37390671 |
| octolytics-dimension-repository_nwo | nodejs/docs |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 37390671 |
| octolytics-dimension-repository_network_root_nwo | nodejs/docs |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | e6a744804e8e70f97b4d5a18a94dcc63db22f97a |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width