doc: add table of contents to README.md #11635
Conversation
I have added a TOC to the top of the readme, relative links to allow jumping to the appropriate section of the readme.
|
Ideally I'd like |
|
Certainly could reorganize it a bit, maybe integrate resources for newcomers to be a part of the initial description above the TOC? |
|
I'm not excited about having Resources for Newcomers repeated twice in the document, nearly verbatim. It's misleading the way it's part of the table of contents, as the links do not go to other parts of the document. They go to external resources. That seems like it would violate user expectations.
|
|
Other than my previous concern, +💯 to including a table of contents in this doc. 👍 |
|
Can we merge this? |
Looks like @Trott's change needs to be implemented (ping @Minimalistic):
The other raised issue was @Fishrock123's :
@Minimalistic if you're going to change that in this PR as well please do it as a separate commit, otherwise it can be done later. |
There was a problem hiding this comment.
I'm not excited about having Resources for Newcomers repeated twice in the document, nearly verbatim. It's misleading the way it's part of the table of contents, as the links do not go to other parts of the document. They go to external resources. That seems like it would violate user expectations.
Resources for Newcomers content should appear once in the doc. (I don't care if we move it higher in the doc, although that should probably be done in a different PR than a PR adding a ToC. It's unrelated.)
If "Resources for Newcomers" appears in the ToC, it should link to the section of the doc that contains Resources for Newcomers and not repeat the content of that section.
Remove repetitious links in "Resources for Newcomers" in TOC
Trott
dismissed
their stale review
Changes have been committed to address my concerns. (Thanks!)
PR-URL: #11635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
jasnell
changed the title
|
Landed in f62d9fc |
PR-URL: nodejs#11635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: #11635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
|
This is really useful! Great work. |
PR-URL: #11635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
PR-URL: nodejs/node#11635 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
I have added a Table of Contents to the top of the readme which includes relative links to allow jumping to the appropriate section of the readme.
Checklist
Affected core subsystem(s)