doc: Updating Table of Content in Building.md #28264
Closed
Conversation
This file contains 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
1. First time user (like me) could not see the instruction to install all prerequisites using the bootstrapping guide because it was not properly linked in the table of contents. 2. The 'Prerequisites' link in the table of content links only to the 'prerequisites' for Unix/macOS skipping over the 'prerequisites' section that refers to the bootstrapping guide. I added a new link to the section that refers to the bootstrapping guide called it 'Installing Prerequisites' and removed the link to the prerequisite under Unix/macOS section. Now both Unix/macOS and the Windows section do not have their prerequisites in the 'table of contents'. Initially, only Unix/macOS had.
nodejs-github-bot
added
build
justjavac
reviewed
Jun 28, 2019
|
@nodejs/documentation @nodejs/build This change could use some reviews. |
Now users can clearly see the link to install all prerequisites and can also go straight to either Unix/macOS or Windows prerequisites
|
Sorry, I don't think this patch improves the situation, and the heading levels are wrong as well. I didn't even know we had duplicated (sort of) documentation in tools/bootstrap/README.md! No wonder it's confusing. So I've proposed an alternative @ #28465 to just merge that content into BUILDING.md so we can maintain it in a single place. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A first time user will most likely not see the instruction to install all
prerequisites using the bootstrapping guide because it was not
properly linked in the table of contents. I also did not see it.
The 'Prerequisites' link in the table of content links only to the
'prerequisites' for Unix/macOS skipping over the 'prerequisites'
section that refers to the bootstrapping guide.
I added a new link to the section that refers to the bootstrapping guide
called it 'Installing Prerequisites' and removed the link to the prerequisite
under Unix/macOS section. Now both Unix/macOS and the Windows
section do not have their prerequisites in the 'table of contents'. Initially,
only Unix/macOS had.
Checklist