| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
|
CC @addaleax |
Sorry, something went wrong.
|
@nodejs/documentation |
Sorry, something went wrong.
|
These changes look good to me, but I suspect it would be better to do this by changes rather than one doc at a time. Would you be open to this approach instead?:
Two advantages to this approach:
|
Sorry, something went wrong.
|
@Trott Sounds like a good idea to me! Is it possible to have this PR merged, then I can begin work with your suggested process? p.s. Thanks for the find command, that'll be a lifesaver. |
Sorry, something went wrong.
Yes, as long as you are okay with the potentially increased backporting workload for you that Rich mentioned. 👍 |
Sorry, something went wrong.
I'm okay with that, I don't think I will run into any issue. Thanks for the help! |
Sorry, something went wrong.
|
@ChrisAHolland what would also be useful is a list of the changes you will be making across the docs. For example changing to use pull request instead of PR. Documenting those things somewhere in a guide would be good to make sure we stay consistent after your pass. We might even be able to get the linter to enforce some of them. |
Sorry, something went wrong.
"somewhere in a guide"? Happy to report that we already have exactly such a guide! https://github.com/nodejs/node/blob/master/doc/guides/doc-style-guide.md |
Sorry, something went wrong.
In my opinion, yes, that would be ideal. |
Sorry, something went wrong.
Sounds good! |
Sorry, something went wrong.
PR-URL: #33152 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #33152 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: #33152 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
PR-URL: nodejs#33152 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
| Back | FazBrowse Home | New Git URL |
This pull request is the beginning of me overviewing the entirety of the docs/guides/ folder.
I am aiming to enhance the grammar and make notations more consistent to improve readability and professionalism.
If this pull request is well received and lands, I will continue with the rest of the guides!
Checklist