doc: add internal links and backticks around names #4054
Conversation
mscdex
added
http
|
would you squash the commits? |
|
/cc @nodejs/documentation |
|
Sure @JungMinu, I’ve squashed them and force pushed now. |
svenheden
changed the title
http docs
|
Did we ever decide on a policy for linking out to third parties such as MDN and unix man pages? Also, 27 commits still seems a bit much. |
|
The reason I added links to MDN was because there was already 5 links to it from other parts of the docs, so I figured you thought it was a reliable source. There's one commit per "page", would one PR per page have been better, or one commit with all pages in it? |
|
The (unfortunate) precedent for one-commit per page was set in #3662. I'm +1 on links to MDN, Wikipedia and authoritative sources (like openssl and libuv) where we know the URLs will be consistent over time. I'm concerned about links to man pages as there's no good authoritative source for those, we seem to be using man7.org and I'm not sure why that was chosen. I'm also a strong +1 on switching to |
|
I didn't add any Wikipedia links in this PR (but sorted the link definitions so it might look that way), but I could go through the Wikipedia links and update them if you like. Do you want me to squash the 27 commits into 1? |
|
I'm fine with linking to MDN as it is the most user-friendly resource. Technically, one could link to spec documents, but these are often way to verbose for the average user. I'd prefer all of this in a single commit. Also +1 for correcting links to |
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically
|
Cool, I've squashed it to one commit now and updated the |
|
Rubber stamp LGTM |
|
LGTM, nice work! |
|
LGTM |
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
|
landed second commit from here on v4.x-staging @ 476ac24, only one made it last time / @thealphanerd |
|
bah... sorry about that. I'm playing with some ideas about how this could be automated to minimize on human error. Thanks for taking the time to audit! |
|
+1 for automation. @thealphanerd and I have discussed it a few times and the pain is real. |
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
PR-URL: #4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
* add backticks around names * add single quotes around event names * add parenthesis after function names * add internal links between different sections * add external links to MDN for some JavaScript references * sort the link definitions alphabetically PR-URL: nodejs#4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
PR-URL: nodejs#4054 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io>
I noticed some inconsistencies in the docs that I've fixed in these commits.