Replies: 3 comments
-
@bnb in case you have more context to add that I've missed from the discussions in the mini summit. |
Beta Was this translation helpful? Give feedback.
-
PR related to this -> https://github.com/nodejs/node/pull/41025/files |
Beta Was this translation helpful? Give feedback.
-
I have realized that I should have been specific that it's the |
Beta Was this translation helpful? Give feedback.
-
The recent next-10 mini summit included a deep dive discussion on type support as identified one of the important technical priorities for the ongoing success of Node.js - https://github.com/nodejs/node/blob/master/doc/guides/technical-priorities.md#suitable-types-for-end-users
As part of that deep dive we discussed the model which make sense and identified the highest value next steps that the project could undertake. See the notes in - nodejs/next-10#102
The TLDR; is that improving the structure and consistency of our docs to make them more consumable by automation that generates type documentation would be one of the bigger wins in addition to being beneficial for other reasons.
I'd like to start a discussion on adopting the electron style guide for our docs. Our understanding is that docs in that format can be parsed/types generated with a tool created/used by the electron project.
I'm thinking we could adopt it incrementally, possibly adjust for what's unique in our docs while trying to stay compatible with the existing parser.
Beta Was this translation helpful? Give feedback.
All reactions