FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: add table of contents to README.md by Minimalistic · Pull Request #11635 · nodejs/node · GitHub

/ node Public

doc: add table of contents to README.md - #11635

Closed
Minimalistic wants to merge 2 commits into
nodejs:masterfrom
Minimalistic:patch-1
ConversationCommits (2)ChecksFiles changed
Closed

doc: add table of contents to README.md#11635
Minimalistic wants to merge 2 commits into
nodejs:masterfrom
Minimalistic:patch-1

Conversation

Minimalistic commented Mar 1, 2017

Copy link
Copy Markdown
Contributor

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
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

Table of Contents and Relative Links
4be48b1 
I have added a TOC to the top of the readme, relative links to allow jumping to the appropriate section of the readme.
nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 1, 2017

Fishrock123 commented Mar 1, 2017

Copy link
Copy Markdown
Contributor

Ideally I'd like Resources for Newcomers to be above the TOC

Fishrock123 closed this Mar 1, 2017
Fishrock123 reopened this Mar 1, 2017

Minimalistic commented Mar 1, 2017

Copy link
Copy Markdown
Contributor Author

Certainly could reorganize it a bit, maybe integrate resources for newcomers to be a part of the initial description above the TOC?

Trott commented Mar 2, 2017

Copy link
Copy Markdown
Member

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.

Trott commented Mar 2, 2017

Copy link
Copy Markdown
Member

Other than my previous concern, +💯 to including a table of contents in this doc. 👍

fhinkel commented Mar 26, 2017

Copy link
Copy Markdown
Contributor

Can we merge this?

gibfahn commented Mar 26, 2017

Copy link
Copy Markdown
Member

Can we merge this?

Looks like @Trott's change needs to be implemented (ping @Minimalistic):

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.

The other raised issue was @Fishrock123's :

Ideally I'd like Resources for Newcomers to be above the TOC

@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.

Trott previously requested changes Mar 26, 2017
View reviewed changes

Trott left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

docs: Revised TOC
3cf499e 
Remove repetitious links in "Resources for Newcomers" in TOC
Trott dismissed their stale review March 28, 2017 04:43

Changes have been committed to address my concerns. (Thanks!)

jasnell pushed a commit that referenced this pull request Apr 4, 2017
doc: add table of contents to README.md
f62d9fc 
PR-URL: #11635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
jasnell changed the title Table of Contents and Relative Links doc: add table of contents to README.md Apr 4, 2017

jasnell commented Apr 4, 2017

Copy link
Copy Markdown
Member

Landed in f62d9fc

jasnell closed this Apr 4, 2017
jasnell mentioned this pull request Apr 4, 2017
Closed
italoacasas pushed a commit to italoacasas/node that referenced this pull request Apr 10, 2017
doc: add table of contents to README.md
961c89c 
PR-URL: nodejs#11635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
italoacasas mentioned this pull request Apr 10, 2017
Merged
2 tasks
MylesBorins pushed a commit that referenced this pull request Apr 18, 2017
doc: add table of contents to README.md
90caad4 
PR-URL: #11635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>

MylesBorins commented Apr 18, 2017

Copy link
Copy Markdown
Contributor

This is really useful! Great work.

MylesBorins pushed a commit that referenced this pull request Apr 19, 2017
doc: add table of contents to README.md
f4dd304 
PR-URL: #11635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
MylesBorins mentioned this pull request Apr 19, 2017
Merged
andrew749 pushed a commit to michielbaird/node that referenced this pull request Jul 19, 2017
doc: add table of contents to README.md
9ad4627 
PR-URL: nodejs/node#11635
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

jasnell jasnell approved these changes
Trott Trott left review comments
+1 more reviewer
thefourtheye thefourtheye approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

doc Issues and PRs related to the documentations.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

9 participants

Back | FazBrowse Home | New Git URL