Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Suitable types - Mini Summit Deep Dive next steps #104

Closed
2 of 5 tasks
mhdawson opened this issue Nov 24, 2021 · 4 comments
Closed
2 of 5 tasks

Suitable types - Mini Summit Deep Dive next steps #104

mhdawson opened this issue Nov 24, 2021 · 4 comments

Comments

@mhdawson
Copy link
Member

mhdawson commented Nov 24, 2021

  • Document target flow for Node.js type generation
  • Staring discussion on adopting Electron style guide
  • Further explore Electron TypesParser to see if it can be used to generate JSON
    for Node.js project
  • Explore how we'd move metadata from comments/YAML to markdown as they
    are currenlty not rendered and it would also help exposing through TypesParser
  • Rethink how doc is structured with respect to API documentation versus other
    things. Should JavaScript API docs and other topics be more separated?
@mhdawson
Copy link
Member Author

Node.js discussion related to Electron Style guide - nodejs/node#40953

mhdawson added a commit to mhdawson/io.js that referenced this issue Jan 10, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@mhdawson
Copy link
Member Author

PR for the first entry in the list -nodejs/node#41464

mhdawson added a commit to mhdawson/io.js that referenced this issue Jan 24, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>
mhdawson added a commit to nodejs/node that referenced this issue Jan 25, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
Linkgoron pushed a commit to Linkgoron/node that referenced this issue Jan 31, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: nodejs#41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
ruyadorno pushed a commit to nodejs/node that referenced this issue Feb 8, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
danielleadams pushed a commit to nodejs/node that referenced this issue Mar 2, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
danielleadams pushed a commit to nodejs/node that referenced this issue Mar 3, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
danielleadams pushed a commit to nodejs/node that referenced this issue Mar 14, 2022
Refs: nodejs/next-10#104

Add initial doc to capture how the project supports
the flow for types generation. Based on discussions
from the Next-10 mini-summit that included project
members and members of the Definitely Typed team.

Will need to be updated as we improve the flow and
resulting json but captures the current flow and
approach and will give us the place where we can
update as things change.

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #41464
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
@sheplu
Copy link
Member

sheplu commented Jan 18, 2023

Should this issue be linked (or integrated) into the new documentation model ?

Seems like the first point landed, and the other are related to the documentation - if I am not mistaken.

@mhdawson
Copy link
Member Author

mhdawson commented Mar 1, 2023

Current assumption is the documentation from @ovflowd proposal will cover this.

@mhdawson mhdawson closed this as completed Mar 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants