doc: improve README.md usability #42378
Merged
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
|
Before in dark mode:
After in dark mode:
|
targos
approved these changes
Mar 17, 2022
|
Before in light mode:
After in light mode:
|
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno.
|
Current raw display:
Raw display with this PR:
|
Trott
added
the
author ready
aduh95
approved these changes
Mar 17, 2022
lpinca
approved these changes
Mar 17, 2022
HarshithaKP
approved these changes
Mar 18, 2022
Mesteery
approved these changes
Mar 19, 2022
Trott
added
the
commit-queue
nodejs-github-bot
removed
the
commit-queue
|
Landed in 7fdb9d5 |
bengl
pushed a commit
that referenced
this issue
Mar 21, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: #42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
Merged
danielleadams
pushed a commit
to danielleadams/node
that referenced
this issue
Apr 21, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: nodejs#42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
danielleadams
pushed a commit
that referenced
this issue
Apr 24, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: #42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
danielleadams
pushed a commit
that referenced
this issue
Apr 24, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: #42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
danielleadams
pushed a commit
that referenced
this issue
Apr 24, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: #42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
xtx1130
pushed a commit
to xtx1130/node
that referenced
this issue
Apr 25, 2022
* The logo takes a lot of room doesn't add information. * Make Node.js a top-level header and Table of Contents a second-level header. This looks better, improve semantics, makes the README.md more usable in its raw form, and aligns us with README.md practices in other projects like TypeScript and Deno. PR-URL: nodejs#42378 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Harshitha K P <harshitha014@gmail.com> Reviewed-By: Mestery <mestery@protonmail.com>
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.
header.
This looks better, improve semantics, makes the README.md more usable in
its raw form, and aligns us with README.md practices in other projects
like TypeScript and Deno.