doc: add link to [customizing util.inspect colors]. #3749
Conversation
mscdex
added
doc
|
LGTM |
|
LGTM |
|
@jmm ... can you please rebase and update this? |
jmm
force-pushed
the
console-colors-docs-v5-02
branch
from
db4b07f
to
923413c
Compare
|
@jasnell Sure, done. Is there any special logic to where the link references were moved to (as opposed to the bottom)? (FWIW I generally prefer to just inline links.) |
|
I don't believe so. The docs were just restructured to use an alphabetical sort. This LGTM! |
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
Landed in b445938 |
|
@jasnell Thanks. Would there be any interest in enhancing the build scripts so that docs can be built with an existing Node installation (re: # 2 above)? |
|
@jmm likely yes. You may want to engage the @nodejs/documentation team /cc @chrisdickinson |
|
@jasnell Ok, thanks. Is there something for me to do to follow up on that, or just wait and see if they comment here? |
|
Well, if the changes in #2 that you're suggesting are not in this PR, the best thing would be to either update this PR or create a new one with those changes and cc the documentation team. |
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
landed in v4.x-staging in 877d86d |
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
|
@jasnell Thanks. Yeah, this PR made no attempt to change the build process, just markdown. I wanted to at least get some kind of thumbs up for the general idea / see if someone who's better at Make was interested in doing it. I took a stab at it: #3888. I tried cc'ing @nodejs/documentation, but it doesn't appear I can. I'm also not sure where I could find out who's on the team. |
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
PR-URL: #3749 Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: James M Snell <[email protected]>
Previously this said "see below" to nowhere.
Applicable to 4.x and 5.x.
Another option would be to link to the
util.inspect()documentation for all of the options (showHidden|depth|colors) instead of duplicating them (that'd be my preference, unless the build system can accomodate that content being located in one place and inserted in both places in the output).The task for building the docs depends on building Node? That is prohibitively slow for making docs changes. (I'm doing it where I already have a functioning Node installation.) I had to hack the build scripts to get around that to be able to make these changes, and I wouldn't attempt this again without being able to build them using the existing Node install. It's possible I've misunderstood or done something wrong -- I just followed the instructions from the README:
$ make doc.What does
CONTRIBUTING.mdmean?:Less strict than what?