You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
JSDoc has been extremely slow to define standards on how to document the new ES features. It also seems more and more likely that the project is no longer being maintained.
In the meantime, the JavaScript community is still left with no clear way to document async, Promises, destructured arguments, and much more.
I think it might be time to fork https://github.com/jsdoc3/jsdoc3.github.com and create a place where these new features can be discussed by the community, standardised, and documented. It would also be a good opportunity to update the examples provided by usejsdoc.org by adding versions that use the new ES syntaxes.
documentationjs looks really promising and is already tackling a large amount of issues jsdoc has left unanswered. Imo it seems like this project would be a good fit for that task.
What do you think ?
The text was updated successfully, but these errors were encountered:
Yep! I'd love to get great documentation-documentation online. We still have a bunch of tags to implement #9 since there are lots and many are kind of non-essential - so I guess we could indicate support on the site. Is this something you'd be interested in helping out with?
I'd definitely like to help out. Do you have a list of things you want done? I can start working on them as soon as you have a repository set up and ready to accept PRs.
Per documentation direction, for post-documentation-js work, I'm not planning on adopting the JSDoc project, and don't really have the time & energy to maintain usejsdoc.org. I will be pushing for a simplified, modernized documentation standard, but it won't be backwards-compatible with JSDoc.
That said, if anyone does want to adopt JSDoc or help them out, please do! There's lots of utility there, and the maintainers would much appreciate the help.
JSDoc has been extremely slow to define standards on how to document the new ES features. It also seems more and more likely that the project is no longer being maintained.
In the meantime, the JavaScript community is still left with no clear way to document
async
,Promise
s, destructured arguments, and much more.I think it might be time to fork https://github.com/jsdoc3/jsdoc3.github.com and create a place where these new features can be discussed by the community, standardised, and documented. It would also be a good opportunity to update the examples provided by usejsdoc.org by adding versions that use the new ES syntaxes.
documentationjs looks really promising and is already tackling a large amount of issues jsdoc has left unanswered. Imo it seems like this project would be a good fit for that task.
What do you think ?
The text was updated successfully, but these errors were encountered: