doc: add note regarding file structure in src/README.md#35000
doc: add note regarding file structure in src/README.md#35000lundibundi wants to merge 1 commit into
Conversation
Refs: nodejs#34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net>
addaleax
left a comment
There was a problem hiding this comment.
The text sounds good, but since it’s a stylistic question, maybe rather add it to the style guide?
|
@addaleax I'm not sure, I can move it there but personally I'd not expect the info regarding files structure to be in the style guide. Though looking at it right now it already has |
|
ping @addaleax @nodejs/documentation, wdyt #35000 (comment)? |
|
@lundibundi I don’t have any strong opinions there, feel free to go with what you think is right :) |
Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Refs: #34944 (comment) Co-authored-by: Anna Henningsen <anna@addaleax.net> PR-URL: #35000 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>

Refs: #34944 (comment)
Mostly adapted from @addaleax comment (I hope you don't mind) on the files structure since this information seems to be missing from our guides and it would be helpful for people unfamiliar/new with C++.
Checklist
make -j4 test(UNIX), orvcbuild test(Windows) passes/cc @nodejs/documentation @Trott